Get fetch configurations

View as markdown
GET /fetch-configurations
O auth2

Get fetch configurations with filtering

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.

Query parameters

  • id array[string]

    ID(s) to be considered for filtering

    At least 1 element. Minimum length of each is 1.

  • offset string(positive-integer)

    Default value is 0.

  • limit string(positive-integer)

    Format should match the following pattern: ^([1-9]|[1-9][0-9]{1,2}|1000)$. Default value is 25.

  • with-deleted boolean

    Includes deleted resources in the results

Responses

  • 200 application/json

    Successful operation

    Hide response attributes Show response attributes object
    • data array[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.

      • 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 attribute Show headers attribute object
        • name string Required

          Minimum length is 1.

      • 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.

    • meta object Required

      Additional properties are NOT allowed.

      Hide meta attributes Show meta attributes object
      • offset integer Required

        Minimum value is 0. Default value is 0.

      • limit integer Required

        Minimum value is 0. Default value is 25.

      • totalCount integer Required

        Minimum value is 0.
GET /fetch-configurations 
curl \
 --request GET 'https://api.development.pexipengage.com/enterprises/acme/fetch-configurations' \
 --header "Authorization: Bearer eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" \
 --header "X-Correlation-Id: a4f0048e-c983-11ed-afa1-0242ac120002"
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"
    }
  ],
  "meta": {
    "offset": 0,
    "limit": 25,
    "totalCount": 42
  }
}