SOsocotra

POST /document/{tenantLocator}/documents/attach

Request

Path parameters

tenantLocatorstring uuid required

Query parameters

referenceLocatorstring ulid required
referenceType'quote' | 'policy' | 'invoice' | 'transaction' | 'segment' | 'term' | 'quoteGroup' required
namestring required
staticNamestring
documentFormat'csv' | 'doc' | 'docx' | 'eml' | 'html' | 'jpeg' | 'jpg' | 'msg' | 'pdf' | 'text' | 'txt' | 'xls' | 'xlsx' | 'zip' required
metadatastring
transactionLocatorstring ulid
segmentLocatorstring ulid
categorystring
copyOnIssuanceboolean

Request body multipart/form-data

documentstring binary required

Response

OK

locatorstring ulid required
referenceLocatorstring ulid required
referenceType'quote' | 'policy' | 'invoice' | 'transaction' | 'segment' | 'term' | 'quoteGroup' required
referenceDocumentLocatorstring ulid
transactionLocatorstring ulid
segmentLocatorstring ulid
termLocatorstring ulid
policyLocatorstring ulid
namestring
staticNamestring
documentInstanceState'draft' | 'dataReady' | 'ready' | 'dataError' | 'renderError' | 'conversionError' | 'rendered' | 'removed' required
documentFormat'csv' | 'doc' | 'docx' | 'html' | 'jpeg' | 'jpg' | 'pdf' | 'text' | 'txt' | 'xls' | 'xlsx' | 'zip' required
metadataobject required
createdAtstring date-time required
createdBystring uuid
readyAtstring date-time
renderingDataobject required
processingErrorsstring
externalboolean required
categorystring
consolidatedFromstring[] required
consolidatedTostring[] required
copyOnIssuanceboolean

Changes

No recorded changes to this operation across all 1 revision of this API.