Update a fetch configuration

PATCH /fetch-configurations/{id}

OAuth2

Update a fetch configuration by its ID

Headers

Authorization string

Bearer token used for authorization

Minimum length is 1.
X-Correlation-Id string

Unique identifier to allow referencing a particular transaction or event chain

Minimum length is 1.

Path parameters

id string Required

Primary identifier of the requested resource

Minimum length is 1.

application/json

Body

body string | null

Minimum length is 1.
mapping array[object]

At least 1 element.
Hide mapping attributes Show mapping attributes object
- sourceProperty string Required
  
  Minimum length is 1.
- targetProperty string Required
  
  Minimum length is 1, maximum length is 512.
- Additional properties are NOT allowed
endpoint string(uri)

Minimum length is 1.
method string

Values are DELETE, GET, PATCH, POST, or PUT.
headers array[object] | null

At least 1 element.
Hide headers attributes Show headers attributes object
- name string Required
  
  Minimum length is 1.
- value string Required
  
  Minimum length is 1.
- Additional properties are NOT allowed

Responses

200 application/json

Successful operation
Hide response attributes Show response attributes object
- data object Required
  
  Hide data attributes Show data attributes object
  
  id string Required
  
  Minimum length is 1.
  
  body string | null
  
  Minimum length is 1.
  
  mapping array[object] Required
  
  At least 1 element.
  
  Hide mapping attributes Show mapping attributes object
  
  sourceProperty string Required
  
  Minimum length is 1.
  
  targetProperty string Required
  
  Minimum length is 1, maximum length is 512.
  
  Additional properties are NOT allowed
  
  endpoint string(uri) Required
  
  Minimum length is 1.
  
  method string Required
  
  Values are DELETE, GET, PATCH, POST, or PUT.
  
  headers array[object] Required
  
  At least 1 element.
  
  Hide headers attributes Show headers attributes object
  
  name string Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
  
  createdAt string(date-time) Required
  
  Minimum length is 1.
  
  updatedAt string(date-time) Required
  
  Minimum length is 1.
  
  deletedAt string(date-time) | null Required
  
  Minimum length is 1.
  
  Additional properties are NOT allowed
- Additional properties are NOT allowed
404 application/json

Resource not found
Hide response attribute Show response attribute object
- errors array[object] Required
  
  At least 1 element.
  
  Hide errors attributes Show errors attributes object
  
  message string Required
  
  Minimum length is 1.
  
  code string Required
  
  Minimum length is 1.
  
  type string Required
  
  Minimum length is 1.
  
  statusCode string Required
  
  Minimum length is 1.
422 application/json

Business validation failed

See Error codes
Hide response attribute Show response attribute object
- errors array[object] Required
  
  At least 1 element.
  
  Hide errors attributes Show errors attributes object
  
  message string Required
  
  Minimum length is 1.
  
  code string Required
  
  Minimum length is 1.
  
  type string Required
  
  Minimum length is 1.
  
  statusCode string Required
  
  Minimum length is 1.
  
  arguments object | null

PATCH /fetch-configurations/{id}

curl \
 -X PATCH https://api.development.pexipengage.com/enterprises/acme/fetch-configurations/1234 \
 -H "Content-Type: application/json" \
 -H "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 -H "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002" \
 -d '{"body":"string","mapping":[{"sourceProperty":"string","targetProperty":"string"}],"endpoint":"https://wwww.example.net/abc123","method":"DELETE","headers":[{"name":"Authorization","value":"apiKey ABCDEFG"}]}'

Request examples

# Headers
Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c
X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002

# Payload
{
  "body": "string",
  "mapping": [
    {
      "sourceProperty": "string",
      "targetProperty": "string"
    }
  ],
  "endpoint": "https://wwww.example.net/abc123",
  "method": "DELETE",
  "headers": [
    {
      "name": "Authorization",
      "value": "apiKey ABCDEFG"
    }
  ]
}

Response examples (200)

{
  "data": {
    "id": "123",
    "body": "string",
    "mapping": [
      {
        "sourceProperty": "string",
        "targetProperty": "string"
      }
    ],
    "endpoint": "https://wwww.example.net/abc123",
    "method": "DELETE",
    "headers": [
      {
        "name": "Authorization"
      }
    ],
    "createdAt": "2022-08-17T19:05:21.362Z",
    "updatedAt": "2022-08-17T19:05:21.362Z",
    "deletedAt": "2022-08-17T19:05:21.362Z"
  }
}

Response examples (404)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string"
    }
  ]
}

Response examples (422)

{
  "errors": [
    {
      "message": "string",
      "code": "string",
      "type": "string",
      "statusCode": "string",
      "arguments": {}
    }
  ]
}