Skip to content
Interu API Reference/
/
Retrieve ProcessOutput

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

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

Retrieve ProcessOutput List

Request

Security
ApiKeyAuth
Path
orgIdstringrequired

The organisation identity

processIdstringrequired
Query
startDatestring(date-time)
endDatestring(date-time)
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}/processes/{processId}/outputs?startDate=2019-08-24T14%3A15%3A22Z&endDate=2019-08-24T14%3A15%3A22Z&size=20&page=0' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The request has succeeded.

Bodyapplication/json
contentArray of objects(Transactional.ProcessOutput)required
content[].​dateobjectrequired
content[].​date.​typestringrequired

The type of captured date.

Enum"EXACT""RANGE"
content[].​date.​onstring(date-time)

If Type is EXACT then this precise date is used.

content[].​date.​startstring(date-time)

If type is RANGE then this is the start date.

content[].​date.​endstring(date-time)

If type is RANGE then this is the end date.

content[].​itemsArray of objects(Transactional.ProcessOutputItem)required

The process output items

content[].​items[].​itemstring(uri)required

The URI of the item that was output from the process.

content[].​notestringrequired

A note to attach to the particular output.

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 ProcessOutput

Request

Security
ApiKeyAuth
Path
outputIdstringrequired
orgIdstringrequired

The organisation identity

processIdstringrequired
curl -i -X GET \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/processes/{processId}/outputs/{outputId}' \
  -H 'X-API-Key: YOUR_API_KEY_HERE'

Responses

The request has succeeded.

Bodyapplication/json
dateobjectrequired
date.​typestringrequired

The type of captured date.

Enum"EXACT""RANGE"
date.​onstring(date-time)

If Type is EXACT then this precise date is used.

date.​startstring(date-time)

If type is RANGE then this is the start date.

date.​endstring(date-time)

If type is RANGE then this is the end date.

itemsArray of objects(Transactional.ProcessOutputItem)required

The process output items

items[].​itemstring(uri)required

The URI of the item that was output from the process.

notestringrequired

A note to attach to the particular output.

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
{
  "date": {
    "type": "EXACT",
    "on": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z"
  },
  "items": [
    { … }
  ],
  "note": "string",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Update ProcessOutput

Request

Security
ApiKeyAuth
Path
outputIdstringrequired
orgIdstringrequired

The organisation identity

processIdstringrequired
Headers
contentTypestringrequired
Default application/json
Bodyapplication/jsonrequired
dateobjectrequired
date.​typestringrequired

The type of captured date.

Enum"EXACT""RANGE"
date.​onstring(date-time)

If Type is EXACT then this precise date is used.

date.​startstring(date-time)

If type is RANGE then this is the start date.

date.​endstring(date-time)

If type is RANGE then this is the end date.

itemsArray of objects(Transactional.ProcessOutputItem)required

The process output items

items[].​itemstring(uri)required

The URI of the item that was output from the process.

notestringrequired

A note to attach to the particular output.

curl -i -X PUT \
  'https://developer.interu.io/_mock/reference/api/organisations/{orgId}/processes/{processId}/outputs/{outputId}' \
  -H 'Content-Type: application/json' \
  -H 'X-API-Key: YOUR_API_KEY_HERE' \
  -H 'contentType: application/json' \
  -d '{
    "date": {
      "type": "EXACT",
      "on": "2019-08-24T14:15:22Z",
      "start": "2019-08-24T14:15:22Z",
      "end": "2019-08-24T14:15:22Z"
    },
    "items": [
      {
        "item": "/organisations/{orgId}/items/{itemId}"
      }
    ],
    "note": "string"
  }'

Responses

The request has succeeded.

Bodyapplication/json
dateobjectrequired
date.​typestringrequired

The type of captured date.

Enum"EXACT""RANGE"
date.​onstring(date-time)

If Type is EXACT then this precise date is used.

date.​startstring(date-time)

If type is RANGE then this is the start date.

date.​endstring(date-time)

If type is RANGE then this is the end date.

itemsArray of objects(Transactional.ProcessOutputItem)required

The process output items

items[].​itemstring(uri)required

The URI of the item that was output from the process.

notestringrequired

A note to attach to the particular output.

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
{
  "date": {
    "type": "EXACT",
    "on": "2019-08-24T14:15:22Z",
    "start": "2019-08-24T14:15:22Z",
    "end": "2019-08-24T14:15:22Z"
  },
  "items": [
    { … }
  ],
  "note": "string",
  "id": "string",
  "createdBy": "string",
  "createdTime": "2019-08-24T14:15:22Z",
  "updatedBy": "string",
  "updatedTime": "2019-08-24T14:15:22Z"
}

Outbound Delivery Workflow

Operations
Copyright © iov42 Limited.