Skip to content
Interu API Reference/
/
Retrieve Document

Interu API (v2_28)

Download OpenAPI description
api.json
api.yaml
Languages
Servers
Mock server
https://developer.interu.io/_mock/reference/api/
UAT
https://api.uat.interu.io/

Validation

Apis related to Validation.

Operations

Base Units

Apis related to Base Units.

Operations

Country List

Apis related to Country List.

Operations

Standards

Apis related to Standards.

Operations

Document Types

Apis related to Document Types.

Operations

Location Types

Apis related to Location Types.

Operations

Process Types

Apis related to Process Types.

Operations

Attachments

Apis related to Attachments.

Operations

Documents

Apis related to Documents.

Operations

Retrieve Document List

Request

Retrieve the list of Documents

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

Query
hasContentboolean
namestring
typeIdsArray of strings
contentHashstring
recordStatestring(Common.Enums.RecordState)
Enum"ACTIVE""ARCHIVED"
sizeinteger(int32)>= 1

The number of elements to return in each page. Minimum value must be 1, defaults to 20.

Default 20
pageinteger(int32)>= 0

The pageNo to return. (Zero-based)

Default 0
curl -i -X GET \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/documents?hasContent=true&name=string&typeIds=string&contentHash=string&recordState=ACTIVE&size=20&page=0' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The request has succeeded.

Bodyapplication/json
contentArray of objects(Evidence.Document)required
content[].​namestringrequired

The name of the document. This must be unique.

content[].​typestring(uri)required

The URI to the type of document.

content[].​issuancestring(date-time)required

The date and time when this document was issued.

content[].​validityStartstring(date-time)required

If the document has a validity period, this is when it starts.

content[].​validityEndstring(date-time)required

If the document has a validity period, this is when it ends.

content[].​contentTypestringrequired

The type of the content based on rfc4288 (https://www.rfc-editor.org/rfc/rfc4288)

content[].​contentHashstringrequired

Sha256 32-byte, base64 encoded contentHash. This will be empty if the document content has not yet been provided.

content[].​originalHashstringrequired

Sha256 32-byte, base64 encoded contentHash. For original documents this will match contentHash. It will be different for redacted documents derived from an original document. This will be empty if the document content has not yet been provided.

content[].​contentSizeinteger(int32)required

The size of the file in bytes.

content[].​privatebooleanrequired

If set to true, the document will not be shared.

content[].​recordStatestring
Enum"ACTIVE""ARCHIVED"
content[].​idstring

System assigned id field.

content[].​createdBystring

User who created the record.

content[].​createdTimestring(date-time)

Date & Time that the record was created.

content[].​updatedBystring

Last updated by user.

content[].​updatedTimestring(date-time)

Date & Time that the record was last updated.

pageobject(iov42.Core.Paging.Page)required
page.​sizeinteger(int32)required
page.​pageinteger(int32)required
page.​totalElementsinteger(int32)required
page.​totalPagesinteger(int32)required
Response
application/json
{
  "content": [
    { … }
  ],
  "page": {
    "size": 0,
    "page": 0,
    "totalElements": 0,
    "totalPages": 0
  }
}

Retrieve Document

Request

Retrieve an existing Document

Security
ApiKeyAuth
Path
documentIdstringrequired
orgIdstringrequired

The organisation identity

curl -i -X GET \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/documents/{documentId}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The request has succeeded.

Bodyapplication/json
namestringrequired

The name of the document. This must be unique.

typestring(uri)required

The URI to the type of document.

issuancestring(date-time)required

The date and time when this document was issued.

validityStartstring(date-time)required

If the document has a validity period, this is when it starts.

validityEndstring(date-time)required

If the document has a validity period, this is when it ends.

contentTypestringrequired

The type of the content based on rfc4288 (https://www.rfc-editor.org/rfc/rfc4288)

contentHashstringrequired

Sha256 32-byte, base64 encoded contentHash. This will be empty if the document content has not yet been provided.

originalHashstringrequired

Sha256 32-byte, base64 encoded contentHash. For original documents this will match contentHash. It will be different for redacted documents derived from an original document. This will be empty if the document content has not yet been provided.

contentSizeinteger(int32)required

The size of the file in bytes.

privatebooleanrequired

If set to true, the document will not be shared.

recordStatestring
Enum"ACTIVE""ARCHIVED"
idstring

System assigned id field.

createdBystring

User who created the record.

createdTimestring(date-time)

Date & Time that the record was created.

updatedBystring

Last updated by user.

updatedTimestring(date-time)

Date & Time that the record was last updated.

Response
application/json
{
  "name": "string",
  "type": "/organisations/{orgId}/document-types/{documentTypeId}",
  "issuance": "2019-08-24T14:15:22Z",
  "validityStart": "2019-08-24T14:15:22Z",
  "validityEnd": "2019-08-24T14:15:22Z",
  "contentType": "string",
  "contentHash": "string",
  "originalHash": "string",
  "contentSize": 0,
  "private": true,
  "recordState": "ACTIVE",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Update Document

Request

Update the details of an existing Document

Security
ApiKeyAuth
Path
documentIdstringrequired
orgIdstringrequired

The organisation identity

Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
namestringrequired

The name of the document. This must be unique.

typestring(uri)required

The URI to the type of document.

issuancestring(date-time)required

The date and time when this document was issued.

validityStartstring(date-time)required

If the document has a validity period, this is when it starts.

validityEndstring(date-time)required

If the document has a validity period, this is when it ends.

contentTypestringrequired

The type of the content based on rfc4288 (https://www.rfc-editor.org/rfc/rfc4288)

contentHashstringrequired

Sha256 32-byte, base64 encoded contentHash. This will be empty if the document content has not yet been provided.

originalHashstringrequired

Sha256 32-byte, base64 encoded contentHash. For original documents this will match contentHash. It will be different for redacted documents derived from an original document. This will be empty if the document content has not yet been provided.

contentSizeinteger(int32)required

The size of the file in bytes.

privatebooleanrequired

If set to true, the document will not be shared.

curl -i -X PUT \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/documents/{documentId}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "name": "string",
    "type": "/organisations/{orgId}/document-types/{documentTypeId}",
    "issuance": "2019-08-24T14:15:22Z",
    "validityStart": "2019-08-24T14:15:22Z",
    "validityEnd": "2019-08-24T14:15:22Z",
    "contentType": "string",
    "contentHash": "string",
    "originalHash": "string",
    "contentSize": 0,
    "private": true
  }'

Responses

The request has succeeded.

Bodyapplication/json
namestringrequired

The name of the document. This must be unique.

typestring(uri)required

The URI to the type of document.

issuancestring(date-time)required

The date and time when this document was issued.

validityStartstring(date-time)required

If the document has a validity period, this is when it starts.

validityEndstring(date-time)required

If the document has a validity period, this is when it ends.

contentTypestringrequired

The type of the content based on rfc4288 (https://www.rfc-editor.org/rfc/rfc4288)

contentHashstringrequired

Sha256 32-byte, base64 encoded contentHash. This will be empty if the document content has not yet been provided.

originalHashstringrequired

Sha256 32-byte, base64 encoded contentHash. For original documents this will match contentHash. It will be different for redacted documents derived from an original document. This will be empty if the document content has not yet been provided.

contentSizeinteger(int32)required

The size of the file in bytes.

privatebooleanrequired

If set to true, the document will not be shared.

recordStatestring
Enum"ACTIVE""ARCHIVED"
idstring

System assigned id field.

createdBystring

User who created the record.

createdTimestring(date-time)

Date & Time that the record was created.

updatedBystring

Last updated by user.

updatedTimestring(date-time)

Date & Time that the record was last updated.

Response
application/json
{
  "name": "string",
  "type": "/organisations/{orgId}/document-types/{documentTypeId}",
  "issuance": "2019-08-24T14:15:22Z",
  "validityStart": "2019-08-24T14:15:22Z",
  "validityEnd": "2019-08-24T14:15:22Z",
  "contentType": "string",
  "contentHash": "string",
  "originalHash": "string",
  "contentSize": 0,
  "private": true,
  "recordState": "ACTIVE",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

EUDR

Apis related to EUDR and Due Diligence Statement Submission.

Operations

Connections

Apis related to Connections.

Operations

Locations

Apis related to Locations.

Operations

Materials

Apis related to Materials.

Operations

Products

Apis related to Products.

Operations

Deliveries

Apis related to Deliveries.

Operations

Items

Apis related to Items.

Operations

Orders

Apis related to Orders.

Operations

Processes

Apis related to Processes.

Operations

Outbound Delivery Workflow

Operations
Copyright © iov42 Limited.