Get all federations

GET /references/federations
oAuth

Query parameters

  • page integer

    The page number to return of the result set

  • size integer

    The size of the pages to return

Responses

  • 200 application/json

    Paged data of federations

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

    Hide response attributes Show response attributes object
  • 401

    Unauthorized

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  • 403

    Forbidden

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  • 404 application/json

    Not found

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

    Hide response attribute Show response attribute object
    • errors array[string]

      Validation Error messages
  • 429

    Too many requests, maximum capacity reached. Requests are now throttled.

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  • 500

    Internal Server Error

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  • 502

    Bad Gateway

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

  • 504

    Upstream timeout, insufficient capacity to serve request. More capacity being brought online. Please try again.

    Hide headers attribute Show headers attribute
    • x-fapi-interaction-id string

      An RFC4122 UID used as a correlation id.

      Minimum length is 1, maximum length is 100. Format should match the following pattern: ^[a-zA-Z0-9][a-zA-Z0-9\-]{0,99}$.

GET /references/federations 
curl \
 -X GET https://matls-api.sandbox.raidiam.io/references/federations \
 -H "Authorization: Bearer $ACCESS_TOKEN"
Response examples (200) 
# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "empty": true,
  "numberOfElements": 42,
  "offset": 42,
  "pageNumber": 42,
  "pageable": {
    "number": 42,
    "offset": 42,
    "size": 42,
    "sort": {
      "orderBy": [
        {
          "ascending": true,
          "direction": "ASC",
          "ignoreCase": true,
          "property": "createdAt"
        }
      ],
      "sorted": true
    },
    "sorted": true,
    "unpaged": true
  },
  "size": 42,
  "totalPages": 42,
  "totalSize": 42
}
Response examples (404) 
# Headers
x-fapi-interaction-id: 73cac523-d3ae-2289-b106-330a6218710d

# Payload
{
  "errors": [
    "string"
  ]
}