EverdeenDMS
Documentation sections

Proposed labels

GET

/product_certifications/{certification_id}/labels

List proposed labels

Scopes

  • certifications:read

Parameters

  • certification_idpathstringRequired
  • cursorquerystring
  • limitqueryinteger
  • qquerystringFull-text search on names and titles.

Responses

  • 200OK
    ProposedLabelPageFields (2)
    • dataarray of ProposedLabelRequired
    • next_cursorstring | nullRequiredPass as cursor for the next page; null on the last page.
  • 401Missing, revoked, or expired API key.
  • 403The key lacks the scope.
  • 429Rate limited: 60 requests per minute per key.
POST

/product_certifications/{certification_id}/labels

Create

Scopes

  • certifications:write

Parameters

  • certification_idpathstringRequired
  • Idempotency-KeyheaderstringRequiredStored 24 h per company and key. Same key with a different body returns 422.

Request body

ProposedLabelInput Fields (6)
  • label_namestringRequired
  • label_descriptionstring | null
  • cert_code_affixedboolean
  • approved_by_authorityboolean
  • approval_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
  • rejection_reasonstring | null

Responses

  • 201Created
    ProposedLabelFields (12)
    • idstring
    • versionintegerIncrements on every write. Send it back in If-Match.
    • created_atstring (date-time)
    • updated_atstring (date-time)
    • deleted_atstring | null
    • product_certification_idstring
    • label_namestringRequired
    • label_descriptionstring | null
    • cert_code_affixedboolean
    • approved_by_authorityboolean
    • approval_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
    • rejection_reasonstring | null
  • 400Validation failed.
  • 409Version conflict, external_id taken, or a secret that cannot be replayed.
  • 422Semantically invalid, or an Idempotency-Key reused with a different body.
  • 401Missing, revoked, or expired API key.
  • 403The key lacks the scope.
  • 429Rate limited: 60 requests per minute per key.
GET

/product_certifications/{certification_id}/labels/{id}

Get

Scopes

  • certifications:read

Parameters

  • certification_idpathstringRequired
  • idpathstringRequired

Responses

  • 200OK
    ProposedLabelFields (12)
    • idstring
    • versionintegerIncrements on every write. Send it back in If-Match.
    • created_atstring (date-time)
    • updated_atstring (date-time)
    • deleted_atstring | null
    • product_certification_idstring
    • label_namestringRequired
    • label_descriptionstring | null
    • cert_code_affixedboolean
    • approved_by_authorityboolean
    • approval_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
    • rejection_reasonstring | null
  • 404Not found. Records of other companies are also reported as not found.
  • 401Missing, revoked, or expired API key.
  • 403The key lacks the scope.
  • 429Rate limited: 60 requests per minute per key.
PATCH

/product_certifications/{certification_id}/labels/{id}

Update (partial)

Scopes

  • certifications:write

Parameters

  • certification_idpathstringRequired
  • idpathstringRequired
  • Idempotency-Keyheaderstring
  • If-MatchheaderintegerThe version you last read; 409 version_conflict when it changed.

Request body

ProposedLabelInput Fields (6)
  • label_namestringRequired
  • label_descriptionstring | null
  • cert_code_affixedboolean
  • approved_by_authorityboolean
  • approval_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
  • rejection_reasonstring | null

Responses

  • 200OK
    ProposedLabelFields (12)
    • idstring
    • versionintegerIncrements on every write. Send it back in If-Match.
    • created_atstring (date-time)
    • updated_atstring (date-time)
    • deleted_atstring | null
    • product_certification_idstring
    • label_namestringRequired
    • label_descriptionstring | null
    • cert_code_affixedboolean
    • approved_by_authorityboolean
    • approval_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
    • rejection_reasonstring | null
  • 400Validation failed.
  • 404Not found. Records of other companies are also reported as not found.
  • 409Version conflict, external_id taken, or a secret that cannot be replayed.
  • 422Semantically invalid, or an Idempotency-Key reused with a different body.
  • 401Missing, revoked, or expired API key.
  • 403The key lacks the scope.
  • 429Rate limited: 60 requests per minute per key.
DELETE

/product_certifications/{certification_id}/labels/{id}

Delete (soft; restorable for 30 days)

Scopes

  • certifications:write

Parameters

  • certification_idpathstringRequired
  • idpathstringRequired
  • Idempotency-Keyheaderstring

Responses

  • 204Deleted
  • 404Not found. Records of other companies are also reported as not found.
  • 401Missing, revoked, or expired API key.
  • 403The key lacks the scope.
  • 429Rate limited: 60 requests per minute per key.
POST

/product_certifications/{certification_id}/labels/{id}/restore

Restore within 30 days of deletion

Scopes

  • certifications:write

Parameters

  • certification_idpathstringRequired
  • idpathstringRequired
  • Idempotency-Keyheaderstring

Responses

  • 200OK
    ProposedLabelFields (12)
    • idstring
    • versionintegerIncrements on every write. Send it back in If-Match.
    • created_atstring (date-time)
    • updated_atstring (date-time)
    • deleted_atstring | null
    • product_certification_idstring
    • label_namestringRequired
    • label_descriptionstring | null
    • cert_code_affixedboolean
    • approved_by_authorityboolean
    • approval_datestring | nullCalendar date in the organization's timezone (YYYY-MM-DD).
    • rejection_reasonstring | null
  • 404Not found. Records of other companies are also reported as not found.
  • 401Missing, revoked, or expired API key.
  • 403The key lacks the scope.
  • 429Rate limited: 60 requests per minute per key.