CertificatesGetResultResponse

Response wrapping a paginated list of certificates

data object[]required

List of certificates

Array [

codestringrequired

Certificate code

Default value:

Example: CERT-123

namestringrequired

Certificate name

Default value:

Example: DPE

assetUidstringrequired

Stonal identifier of the asset the certificate belongs to

Default value:

Example: STN-xxxxx

assetCodestringrequired

Preferred external identifier of the asset the certificate belongs to

Default value:

Example: BAT001

effectiveDatestring<date>required

Date from which the certificate is effective

Default value:

Example: 2024-01-01

expirationDatestring<date>required

Date at which the certificate expires

Default value:

Example: 2034-01-01

documentationLinkstring | nullnullable

Link to the certificate documentation

Default value:

Example: https://example.org/certificate.pdf

updatedAtstring<date-time>required

Date of the last update of the certificate

Default value:

]

paginate objectrequired

Pagination information. The cursor field is null when iteration has reached the end.

sizeinteger<int32>

Number of results

Possible values: <= 2000

Default value: 50

cursorstring | nullnullable

A marker indicating the position in a dataset, used to determine where to continue fetching results in paginated data

Default value: 0

CertificatesGetResultResponse

{
  "data": [
    {
      "code": "CERT-123",
      "name": "DPE",
      "assetUid": "STN-xxxxx",
      "assetCode": "BAT001",
      "effectiveDate": "2024-01-01",
      "expirationDate": "2034-01-01",
      "documentationLink": "https://example.org/certificate.pdf",
      "updatedAt": ""
    }
  ],
  "paginate": {
    "size": 50,
    "cursor": "0"
  }
}