Jump to

• Request
• Response

Search references for the specific document version

post

/oitt/api/v1/documents/{documentKey}/versions/{documentVersion}/references/index/_search

The operation returns documents referenced by the document specified by document key and document version.

Permissions

This operation is only available to users who have the DOCUMENT_TRACE permission. Users can access references of the document only if it is allowed to see the document itself. Users can see only references associated with trading partners that are implicit or explicit viewers. Founder users can see all the references.

Operations

This endpoint works like the OpenSearch proxy. Queryable index mapping is the same as in method Search all documents.

Request

Path Parameters

• documentKey(required): string
  A key that uniquely identifies the document.
• documentVersion(required): string
  Version of a document identified by some document key.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

See the request in OpenSearch documentation.

Back to Top

Response

200 Response

See the response in OpenSearch documentation. In the case of the default search (with empty request JSON), the _source field contains an array of the following documents:

Body ()

Root Schema : Document

Type: object

Show Source

• attachments(required): array attachments
  List of attachments related to the document.
• attachmentsCount(required): integer
  Count of attachments.
• documentKey(required): string
  A key that uniquely identifies the document.
• documentNumber(required): string
  Another identifier of the document that may not be unique.
• documentTimestamp(required): string (date-time)
  Time when the document was issued.
• documentType(required): object documentType
  Details about a type of the document.
• documentVersion(required): object documentVersion
  Document version details.
• flow(required): object flow
  Business flow into which the document was submitted.
• receivedTimestamp(required): string (date-time)
  Time when the document was submitted.
• receiver(required): object receiver
  Trading partner receiver.
• referenceKeys(required): array referenceKeys
  A list of keys that can be used to reference this document.
• references(required): array references
  List of reference or document keys referenced by the document.
• step(required): object step
  Business flow step into which the document was submitted.
• submitter(required): object submitter
  Trading partner submitter details.
• transactionValue(required): object transactionValue
  Transaction value details.
• viewers(required): object viewers
  List of trading partners allowed to view the document.

{
    "type":"object",
    "required":[
        "documentKey",
        "referenceKeys",
        "references",
        "documentNumber",
        "documentVersion",
        "documentTimestamp",
        "receivedTimestamp",
        "transactionValue",
        "flow",
        "step",
        "documentType",
        "submitter",
        "receiver",
        "viewers",
        "attachmentsCount",
        "attachments"
    ],
    "properties":{
        "documentKey":{
            "type":"string",
            "description":"A key that uniquely identifies the document."
        },
        "referenceKeys":{
            "type":"array",
            "description":"A list of keys that can be used to reference this document.",
            "items":{
                "type":"object",
                "required":[
                    "key",
                    "lastVersion"
                ],
                "properties":{
                    "key":{
                        "type":"string",
                        "description":"A document identifier that other documents can reference."
                    },
                    "lastVersion":{
                        "type":"boolean",
                        "description":"True if this is the last version of the document that contains this reference key."
                    }
                }
            }
        },
        "references":{
            "type":"array",
            "description":"List of reference or document keys referenced by the document.",
            "items":{
                "oneOf":[
                    {
                        "type":"object",
                        "required":[
                            "referenceKey",
                            "documentKey"
                        ],
                        "properties":{
                            "referenceKey":{
                                "type":"string",
                                "description":"Reference key of the referenced document."
                            }
                        }
                    },
                    {
                        "type":"object",
                        "properties":{
                            "documentKey":{
                                "type":"string",
                                "description":"Document key of the referenced document."
                            }
                        }
                    }
                ]
            }
        },
        "documentNumber":{
            "type":"string",
            "description":"Another identifier of the document that may not be unique."
        },
        "documentVersion":{
            "type":"object",
            "description":"Document version details.",
            "required":[
                "value",
                "latestValue",
                "latest"
            ],
            "properties":{
                "value":{
                    "type":"integer",
                    "description":"The actual version of the document."
                },
                "latestValue":{
                    "type":"integer",
                    "description":"Latest version of the document with same document key."
                },
                "latest":{
                    "type":"boolean",
                    "description":"True if this document is the latest version of the document with same document key."
                }
            }
        },
        "documentTimestamp":{
            "type":"string",
            "description":"Time when the document was issued.",
            "format":"date-time"
        },
        "receivedTimestamp":{
            "type":"string",
            "description":"Time when the document was submitted.",
            "format":"date-time"
        },
        "transactionValue":{
            "type":"object",
            "description":"Transaction value details.",
            "required":[
                "amount",
                "currencyCode"
            ],
            "properties":{
                "amount":{
                    "type":"number",
                    "description":"Transaction amount."
                },
                "currencyCode":{
                    "type":"string",
                    "description":"Transaction currency code."
                }
            }
        },
        "flow":{
            "type":"object",
            "description":"Business flow into which the document was submitted.",
            "required":[
                "name"
            ],
            "properties":{
                "name":{
                    "type":"string",
                    "description":"Business flow name."
                }
            }
        },
        "step":{
            "type":"object",
            "description":"Business flow step into which the document was submitted.",
            "required":[
                "name"
            ],
            "properties":{
                "name":{
                    "type":"string",
                    "description":"Business flow step name."
                }
            }
        },
        "documentType":{
            "type":"object",
            "description":"Details about a type of the document.",
            "required":[
                "name",
                "variantName"
            ],
            "properties":{
                "name":{
                    "type":"string",
                    "description":"Document type name."
                },
                "variantName":{
                    "type":"string",
                    "description":"Document type name."
                }
            }
        },
        "submitter":{
            "type":"object",
            "description":"Trading partner submitter details.",
            "required":[
                "name",
                "businessIdentifiers"
            ],
            "properties":{
                "name":{
                    "type":"string",
                    "description":"Trading partner submitter name."
                },
                "location":{
                    "type":"object",
                    "required":[
                        "name"
                    ],
                    "properties":{
                        "name":{
                            "description":"Trading partner submitter location name.",
                            "type":"string"
                        }
                    }
                },
                "businessIdentifiers":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "required":[
                            "type",
                            "value",
                            "primary"
                        ],
                        "properties":{
                            "type":{
                                "type":"string",
                                "description":"Business identifier type."
                            },
                            "value":{
                                "type":"string",
                                "description":"Business identifier value."
                            },
                            "primary":{
                                "type":"boolean",
                                "description":"Indicates if the business identifier belongs to the most important location."
                            }
                        }
                    }
                }
            }
        },
        "receiver":{
            "type":"object",
            "description":"Trading partner receiver.",
            "required":[
                "name",
                "businessIdentifiers"
            ],
            "properties":{
                "name":{
                    "type":"string",
                    "description":"Receiver trading partner name."
                },
                "location":{
                    "type":"object",
                    "required":[
                        "name"
                    ],
                    "properties":{
                        "name":{
                            "type":"string",
                            "description":"Receiver location name."
                        }
                    }
                },
                "businessIdentifiers":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "required":[
                            "type",
                            "value",
                            "primary"
                        ],
                        "properties":{
                            "type":{
                                "type":"string",
                                "description":"Business identifier type."
                            },
                            "value":{
                                "type":"string",
                                "description":"Business identifier value."
                            },
                            "primary":{
                                "type":"boolean",
                                "description":"Indicates if the business identifier belongs to the most important (primary) location."
                            }
                        }
                    }
                }
            }
        },
        "viewers":{
            "type":"object",
            "description":"List of trading partners allowed to view the document.",
            "required":[
                "name"
            ],
            "properties":{
                "name":{
                    "type":"string",
                    "description":"Name of a viewer."
                }
            }
        },
        "attachmentsCount":{
            "type":"integer",
            "description":"Count of attachments."
        },
        "attachments":{
            "type":"array",
            "description":"List of attachments related to the document.",
            "items":{
                "required":[
                    "mediaType",
                    "fileName",
                    "size"
                ],
                "properties":{
                    "mediaType":{
                        "type":"string",
                        "description":"Attachment media MIME type."
                    },
                    "fileName":{
                        "type":"string",
                        "description":"Attachment file name."
                    },
                    "description":{
                        "type":"string",
                        "description":"Attachment description."
                    },
                    "size":{
                        "type":"integer",
                        "description":"Attachment size in bytes."
                    }
                }
            }
        }
    }
}

Nested Schema : attachments

Type: array

List of attachments related to the document.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"List of attachments related to the document.",
    "items":{
        "required":[
            "mediaType",
            "fileName",
            "size"
        ],
        "properties":{
            "mediaType":{
                "type":"string",
                "description":"Attachment media MIME type."
            },
            "fileName":{
                "type":"string",
                "description":"Attachment file name."
            },
            "description":{
                "type":"string",
                "description":"Attachment description."
            },
            "size":{
                "type":"integer",
                "description":"Attachment size in bytes."
            }
        }
    }
}

Nested Schema : documentType

Type: object

Details about a type of the document.

Show Source

• name(required): string
  Document type name.
• variantName(required): string
  Document type name.

{
    "type":"object",
    "description":"Details about a type of the document.",
    "required":[
        "name",
        "variantName"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Document type name."
        },
        "variantName":{
            "type":"string",
            "description":"Document type name."
        }
    }
}

Nested Schema : documentVersion

Type: object

Document version details.

Show Source

• latest(required): boolean
  True if this document is the latest version of the document with same document key.
• latestValue(required): integer
  Latest version of the document with same document key.
• value(required): integer
  The actual version of the document.

{
    "type":"object",
    "description":"Document version details.",
    "required":[
        "value",
        "latestValue",
        "latest"
    ],
    "properties":{
        "value":{
            "type":"integer",
            "description":"The actual version of the document."
        },
        "latestValue":{
            "type":"integer",
            "description":"Latest version of the document with same document key."
        },
        "latest":{
            "type":"boolean",
            "description":"True if this document is the latest version of the document with same document key."
        }
    }
}

Nested Schema : flow

Type: object

Business flow into which the document was submitted.

Show Source

• name(required): string
  Business flow name.

{
    "type":"object",
    "description":"Business flow into which the document was submitted.",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Business flow name."
        }
    }
}

Nested Schema : receiver

Type: object

Trading partner receiver.

Show Source

• businessIdentifiers(required): array businessIdentifiers
• location: object location
• name(required): string
  Receiver trading partner name.

{
    "type":"object",
    "description":"Trading partner receiver.",
    "required":[
        "name",
        "businessIdentifiers"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Receiver trading partner name."
        },
        "location":{
            "type":"object",
            "required":[
                "name"
            ],
            "properties":{
                "name":{
                    "type":"string",
                    "description":"Receiver location name."
                }
            }
        },
        "businessIdentifiers":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "type",
                    "value",
                    "primary"
                ],
                "properties":{
                    "type":{
                        "type":"string",
                        "description":"Business identifier type."
                    },
                    "value":{
                        "type":"string",
                        "description":"Business identifier value."
                    },
                    "primary":{
                        "type":"boolean",
                        "description":"Indicates if the business identifier belongs to the most important (primary) location."
                    }
                }
            }
        }
    }
}

Nested Schema : referenceKeys

Type: array

A list of keys that can be used to reference this document.

Show Source

• Array of: object items

{
    "type":"array",
    "description":"A list of keys that can be used to reference this document.",
    "items":{
        "type":"object",
        "required":[
            "key",
            "lastVersion"
        ],
        "properties":{
            "key":{
                "type":"string",
                "description":"A document identifier that other documents can reference."
            },
            "lastVersion":{
                "type":"boolean",
                "description":"True if this is the last version of the document that contains this reference key."
            }
        }
    }
}

Nested Schema : references

Type: array

List of reference or document keys referenced by the document.

Show Source

• Array of: items

{
    "type":"array",
    "description":"List of reference or document keys referenced by the document.",
    "items":{
        "oneOf":[
            {
                "type":"object",
                "required":[
                    "referenceKey",
                    "documentKey"
                ],
                "properties":{
                    "referenceKey":{
                        "type":"string",
                        "description":"Reference key of the referenced document."
                    }
                }
            },
            {
                "type":"object",
                "properties":{
                    "documentKey":{
                        "type":"string",
                        "description":"Document key of the referenced document."
                    }
                }
            }
        ]
    }
}

Nested Schema : step

Type: object

Business flow step into which the document was submitted.

Show Source

• name(required): string
  Business flow step name.

{
    "type":"object",
    "description":"Business flow step into which the document was submitted.",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Business flow step name."
        }
    }
}

Nested Schema : submitter

Type: object

Trading partner submitter details.

Show Source

• businessIdentifiers(required): array businessIdentifiers
• location: object location
• name(required): string
  Trading partner submitter name.

{
    "type":"object",
    "description":"Trading partner submitter details.",
    "required":[
        "name",
        "businessIdentifiers"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Trading partner submitter name."
        },
        "location":{
            "type":"object",
            "required":[
                "name"
            ],
            "properties":{
                "name":{
                    "description":"Trading partner submitter location name.",
                    "type":"string"
                }
            }
        },
        "businessIdentifiers":{
            "type":"array",
            "items":{
                "type":"object",
                "required":[
                    "type",
                    "value",
                    "primary"
                ],
                "properties":{
                    "type":{
                        "type":"string",
                        "description":"Business identifier type."
                    },
                    "value":{
                        "type":"string",
                        "description":"Business identifier value."
                    },
                    "primary":{
                        "type":"boolean",
                        "description":"Indicates if the business identifier belongs to the most important location."
                    }
                }
            }
        }
    }
}

Nested Schema : transactionValue

Type: object

Transaction value details.

Show Source

• amount(required): number
  Transaction amount.
• currencyCode(required): string
  Transaction currency code.

{
    "type":"object",
    "description":"Transaction value details.",
    "required":[
        "amount",
        "currencyCode"
    ],
    "properties":{
        "amount":{
            "type":"number",
            "description":"Transaction amount."
        },
        "currencyCode":{
            "type":"string",
            "description":"Transaction currency code."
        }
    }
}

Nested Schema : viewers

Type: object

List of trading partners allowed to view the document.

Show Source

• name(required): string
  Name of a viewer.

{
    "type":"object",
    "description":"List of trading partners allowed to view the document.",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Name of a viewer."
        }
    }
}

Nested Schema : items

Type: object

Show Source

• description: string
  Attachment description.
• fileName(required): string
  Attachment file name.
• mediaType(required): string
  Attachment media MIME type.
• size(required): integer
  Attachment size in bytes.

{
    "required":[
        "mediaType",
        "fileName",
        "size"
    ],
    "properties":{
        "mediaType":{
            "type":"string",
            "description":"Attachment media MIME type."
        },
        "fileName":{
            "type":"string",
            "description":"Attachment file name."
        },
        "description":{
            "type":"string",
            "description":"Attachment description."
        },
        "size":{
            "type":"integer",
            "description":"Attachment size in bytes."
        }
    }
}

Nested Schema : businessIdentifiers

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "type",
            "value",
            "primary"
        ],
        "properties":{
            "type":{
                "type":"string",
                "description":"Business identifier type."
            },
            "value":{
                "type":"string",
                "description":"Business identifier value."
            },
            "primary":{
                "type":"boolean",
                "description":"Indicates if the business identifier belongs to the most important (primary) location."
            }
        }
    }
}

Nested Schema : location

Type: object

Show Source

• name(required): string
  Receiver location name.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "type":"string",
            "description":"Receiver location name."
        }
    }
}

Nested Schema : items

Type: object

Show Source

• primary(required): boolean
  Indicates if the business identifier belongs to the most important (primary) location.
• type(required): string
  Business identifier type.
• value(required): string
  Business identifier value.

{
    "type":"object",
    "required":[
        "type",
        "value",
        "primary"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Business identifier type."
        },
        "value":{
            "type":"string",
            "description":"Business identifier value."
        },
        "primary":{
            "type":"boolean",
            "description":"Indicates if the business identifier belongs to the most important (primary) location."
        }
    }
}

Nested Schema : items

Type: object

Show Source

• key(required): string
  A document identifier that other documents can reference.
• lastVersion(required): boolean
  True if this is the last version of the document that contains this reference key.

{
    "type":"object",
    "required":[
        "key",
        "lastVersion"
    ],
    "properties":{
        "key":{
            "type":"string",
            "description":"A document identifier that other documents can reference."
        },
        "lastVersion":{
            "type":"boolean",
            "description":"True if this is the last version of the document that contains this reference key."
        }
    }
}

Nested Schema : items

Match One Schema

Show Source

• object items-oneOf[0]
• object items-oneOf[1]

{
    "oneOf":[
        {
            "type":"object",
            "required":[
                "referenceKey",
                "documentKey"
            ],
            "properties":{
                "referenceKey":{
                    "type":"string",
                    "description":"Reference key of the referenced document."
                }
            }
        },
        {
            "type":"object",
            "properties":{
                "documentKey":{
                    "type":"string",
                    "description":"Document key of the referenced document."
                }
            }
        }
    ]
}

Nested Schema : items-oneOf[0]

Type: object

Show Source

• referenceKey(required): string
  Reference key of the referenced document.

{
    "type":"object",
    "required":[
        "referenceKey",
        "documentKey"
    ],
    "properties":{
        "referenceKey":{
            "type":"string",
            "description":"Reference key of the referenced document."
        }
    }
}

Nested Schema : items-oneOf[1]

Type: object

Show Source

• documentKey: string
  Document key of the referenced document.

{
    "type":"object",
    "properties":{
        "documentKey":{
            "type":"string",
            "description":"Document key of the referenced document."
        }
    }
}

Nested Schema : businessIdentifiers

Type: array

Show Source

• Array of: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "required":[
            "type",
            "value",
            "primary"
        ],
        "properties":{
            "type":{
                "type":"string",
                "description":"Business identifier type."
            },
            "value":{
                "type":"string",
                "description":"Business identifier value."
            },
            "primary":{
                "type":"boolean",
                "description":"Indicates if the business identifier belongs to the most important location."
            }
        }
    }
}

Nested Schema : location

Type: object

Show Source

• name(required): string
  Trading partner submitter location name.

{
    "type":"object",
    "required":[
        "name"
    ],
    "properties":{
        "name":{
            "description":"Trading partner submitter location name.",
            "type":"string"
        }
    }
}

Nested Schema : items

Type: object

Show Source

• primary(required): boolean
  Indicates if the business identifier belongs to the most important location.
• type(required): string
  Business identifier type.
• value(required): string
  Business identifier value.

{
    "type":"object",
    "required":[
        "type",
        "value",
        "primary"
    ],
    "properties":{
        "type":{
            "type":"string",
            "description":"Business identifier type."
        },
        "value":{
            "type":"string",
            "description":"Business identifier value."
        },
        "primary":{
            "type":"boolean",
            "description":"Indicates if the business identifier belongs to the most important location."
        }
    }
}

403 Response

The user doesn't have permission to view the document.

404 Response

The document doesn't exist.

Back to Top