Download OpenAPI specification:Download
Infinite Proxy session api
Consulting N documents
Requests a list of documents through the request's payload. If the list of documents is left empty, the API will return every document from the project docstore. If any of the specified documents does not exist, it will not be listed in the body of the response.
| projectid required | string 36 characters ^prj_[a-f0-9]{32}$ Example: prj_091d232caeae2c0d2e4e63b031534c5b the unique identifier of the project |
| content-length required | integer <= 16777216 json body is limited to 16MB |
Requested document id.
[- "string"
]{- "docs": [
- { }
]
}Uploading modifications to existing documents
Uploads a list of documents or patches. The content-type of the request must be set to application/x-ndjson, and, accordingly, the payload must consist in a collection of json documents separated by the \n character.
All the uploaded documents are validated prior to the update, which means they must contain valid id and ts fields, as well as a number of other required fields that differs depending on the document type (see the Integration Manual for a list of documents types and their fields).
Any operation only takes place if the timestamp (ts field) of the uploaded document is higher than the timestamp of the document present in the docstore.
Any rejection of a document (e.g. malformed json, document id mismatch, missing or invalid fields, timestamp rejection) will be notified in the request's response.
Two methods are available to modify documents, under the names replace and patch. The update method must be specified as the docupdatemethod query parameter.
- The replace method is applicable to any type of document. It requires every field of the document to be present. If successful, the operation is an overwrite of the existing document with the uploaded document.
- The patch method is applicable only to documents of type linkmetadata, instancemetadata and partmetadata. Document fields that are otherwise required become optional. When fields are json objects, all sub-fields at level 0 of the uploaded document are inserted in the existing document (this operation may either replace or insert a sub-field). When fields are not objects, the uploaded version of the field replaces the existing field.
Note: In the case of documents of type attacheddocument, both the url and base64 must be provided, and the url must be left empty for the base64 field to be used.
Note: In the case of project documents, the version field must be provided and contain the correct version number.
| projectid required | string 36 characters ^prj_[a-f0-9]{32}$ Example: prj_091d232caeae2c0d2e4e63b031534c5b the unique identifier of the project |
| docupdatemethod required | string Enum: "replace" "patch" |
| content-length required | integer <= 33554432 |
"string"{- "documents": {
- "failed": 0,
- "succeeded": 0,
- "total": 0
}, - "errors": true,
- "items": [
- {
- "id": "string",
- "line": 0,
- "message": "string",
- "result": "patched"
}
], - "syntaxerrors": 0,
- "took": 0
}Consulting one document
Requests a single documents specified in the url.
Note : This request can alternatively be called with the verb POST for the exact same behaviour
| projectid required | string 36 characters ^prj_[a-f0-9]{32}$ Example: prj_091d232caeae2c0d2e4e63b031534c5b the unique identifier of the project |
| documentid required | string |
{- "docs": [
- { }
]
}Consulting one document
Requests a single documents specified in the url.
Note : This request can alternatively be called with the verb GET for the exact same behaviour
| projectid required | string 36 characters ^prj_[a-f0-9]{32}$ Example: prj_091d232caeae2c0d2e4e63b031534c5b the unique identifier of the project |
| documentid required | string |
{- "docs": [
- { }
]
}