CommonsDB Developer PortalCommonsDB Developer PortalCommonsDB Developer Portal
  • Documentation
  • Declaration API
  • Metadata API
  • Search API
  • Status API
status
    Get declaration processing statusget
Schemas
powered by Zudoku
Status Engine API

Schemas


StatusResponse

  • identifierstring · required

    The CIDv1 identifier of the declaration

  • statusstring · enum · required

    Current processing status of the declaration:

    • pending: Declaration is in the processing queue
    • success: Declaration was successfully processed and is now searchable
    • failed: Processing failed - see message for error details
    Enum values:
    pending
    success
    failed
  • versionstring · required

    API version

  • messagestring

    Additional information about the status. Contains error details when status is 'failed'.

  • createdAtinteger · int64

    Unix timestamp (milliseconds) when the status record was created (i.e., when declaration was submitted)

  • createdAtDateTimestring

    Human-readable date/time when the status record was created

  • updatedAtinteger · int64

    Unix timestamp (milliseconds) when the status was last updated

  • updatedAtDateTimestring

    Human-readable date/time when the status was last updated

ErrorResponse

  • errorstring

    Error type or title

  • messagestring

    Detailed error message

  • errorBodystring

    Additional error details (for 500 errors)

On this page
  • StatusResponse
  • ErrorResponse