getExpiredDocumentWithCursorPaginate

GET /api/expiring-document

getExpiredDocumentWithCursorPaginate

cURL

curl --request GET \
  --url https://api.artemis.cynopsis.co/api/expiring-document \
  --header 'Authorization: Bearer <token>' \
  --header 'X-Domain-ID: <x-domain-id>'

200

{
  "items": [
    {
      "assignees": [
        {
          "email": "<string>",
          "firstName": "<string>",
          "fullName": "<string>",
          "id": 123,
          "lastName": "<string>"
        }
      ],
      "authenticity": "<string>",
      "back": "<string>",
      "backName": "<string>",
      "createdAt": {
        "date": 123,
        "day": 123,
        "hours": 123,
        "minutes": 123,
        "month": 123,
        "nanos": 123,
        "seconds": 123,
        "time": 123,
        "timezoneOffset": 123,
        "year": 123
      },
      "createdBy": {
        "email": "<string>",
        "firstName": "<string>",
        "fullName": "<string>",
        "id": 123,
        "lastName": "<string>"
      },
      "customerId": 123,
      "expiryDate": "2023-12-25",
      "front": "<string>",
      "frontName": "<string>",
      "id": 123,
      "issueDate": "2023-12-25",
      "number": "<string>",
      "parentCustomerId": 123,
      "parentParticular": {},
      "particular": {},
      "showExpiryNotification": true,
      "type": "<string>",
      "updatedAt": {
        "date": 123,
        "day": 123,
        "hours": 123,
        "minutes": 123,
        "month": 123,
        "nanos": 123,
        "seconds": 123,
        "time": 123,
        "timezoneOffset": 123,
        "year": 123
      },
      "updatedBy": {
        "email": "<string>",
        "firstName": "<string>",
        "fullName": "<string>",
        "id": 123,
        "lastName": "<string>"
      }
    }
  ],
  "nextToken": "<string>",
  "total": 123
}

Authorizations

OAuth2_Client_CredentialsOAuth2_Password

Authorization · string · header · required

The access token received from the authorization server in the OAuth 2.0 flow.

Headers

X-Domain-ID · integer<int64> · required

X-Domain-ID

Query Parameters

authority · string

claims · object

domains[0].id · integer<int64>

domains[0].name · string

email · string

endDate · string<date>

endDate

headers · object

nextToken · string

nextToken

pageSize · integer<int32> · default: 10

pageSize

scopes · string

startDate · string<date>

startDate

tokenValue · string

userId · string

Response

200

*/*

OK

items · DocumentResponseDto · object[]

Show child attributes

nextToken · string

total · integer<int64>