Tracr XPS API V1

Get Traceability Ancestry

post

Get traceability ancestry for multiple diamonds from many peers.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

Represents a request to the /diamonds/traceability-ancestry endpoint.

Responses

200

Successful Response

application/json

Represents a response from the /diamonds/traceability-ancestry endpoint.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

application/json

403

Forbidden: The application does not have sufficient permissions for this operation.

application/json

422

Validation Error

application/json

post/v1/bulk/traceability-ancestry

POST /v1/bulk/traceability-ancestry HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 160

{
  "data": [
    {
      "diamonds": [
        {
          "diamond_id": "e1mv3nn4n10kd1lw6mde6sums"
        }
      ],
      "modified_since": "1970-01-01T00:00:00",
      "platform_id": "123e4567-e89b-12d3-a456-426614174000"
    }
  ]
}

No content

Get Diamonds

get

Search for diamonds matching the given query.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Query parameters

pageinteger · min: 1Optional

Page number

Default: 1

sizeinteger · min: 1 · max: 1000OptionalDefault: 100

searchstringRequired

Responses

200

Successful Response

application/json

nextstring · nullableOptional

The URL for the next page.

pageinteger · min: 1 · nullableRequired

The number of the current page.

pagesinteger · nullableOptional

The total number of pages.

previousstring · nullableOptional

The URL of the previous page.

totalintegerRequired

The total number of results across all pages.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

application/json

403

Forbidden: The application does not have sufficient permissions for this operation.

application/json

422

Validation Error

application/json

get/v1/diamonds/

GET /v1/diamonds/?search=text HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "next": "text",
  "page": 1,
  "pages": 1,
  "previous": "text",
  "results": [
    {
      "diamond": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      },
      "identity_type": "diamond_id",
      "locked_diamond": {
        "ANY_ADDITIONAL_PROPERTY": "anything"
      }
    }
  ],
  "total": 1
}

Get Diamond

get

Look up a single diamond in Tracr and return its data if it exists.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

diamond_idstringRequiredExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

Responses

200

Successful Response

application/json

Detailed data of a diamond.

assurance_levelstring · enumRequired

Represents the assurance level for a diamond.

Possible values:

current_stagestring · enumRequiredPossible values:

diamond_idstringRequiredExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

diamond_parent_idstring · nullableOptionalExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

lifecycle_statestring · enumRequiredPossible values:

polished_objective_verificationbooleanOptionalDefault: false

producer_uuidstring · uuidRequired

rough_objective_verificationbooleanRequired

unlock_statusstring · enumRequired

Represents the unlock status of a diamond, as returned by the API.

Possible values:

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

application/json

403

Forbidden: The application does not have sufficient permissions for this operation.

application/json

404

Diamond not found.

application/json

409

It was not possible to determine which Tracr instance holds this diamond.

application/json

422

Validation Error

application/json

get/v1/diamonds/{diamond_id}

GET /v1/diamonds/{diamond_id} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Diamond File

get

Fetch a single file's pre-signed URL and return a Response.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

diamond_idstringRequiredExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

file_hashstringRequired

Responses

302

Successful Response

application/json

anyOptional

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

application/json

403

Forbidden: The application does not have sufficient permissions for this operation.

application/json

404

Diamond or file not found.

application/json

409

It was not possible to determine which Tracr instance holds this diamond.

application/json

410

The file was found in the Tracr network but a pre-signed URL could not be generated.

application/json

422

Validation Error

application/json

502

An unexpected response was received from the participant's API.

application/json

get/v1/diamonds/{diamond_id}/files/{file_hash}

GET /v1/diamonds/{diamond_id}/files/{file_hash} HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

Get Diamond History

get

Look up a single diamond in Tracr and return its history.

Authorizations

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Path parameters

diamond_idstringRequiredExample: e1mv3nn4n10kd1lw6mde6sumsPattern: ^[a-z\d]{20,98}$

Responses

200

Successful Response

application/json

A version of FullReadView containing only traceability data.

401

Unauthorized: The request has not been applied because it lacks valid authentication credentials for the target resource.

application/json

403

Forbidden: The application does not have sufficient permissions for this operation.

application/json

404

Diamond not found.

application/json

409

It was not possible to determine which Tracr instance holds this diamond.

application/json

422

Validation Error

application/json

get/v1/diamonds/{diamond_id}/history

GET /v1/diamonds/{diamond_id}/history HTTP/1.1
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content

PreviousGet Started with Tracr Search -Authenticated NextTracr XPS API V2

Last updated 23 days ago