Set document's attributes

PUT 
/documents/:documentId/attributes

Set multiple attributes to a document; this endpoint also accepts a different body parameter for setting a single attribute

Note:

• attributes in the request will overwrite existing attributes.

Request

Path Parameters

documentId stringrequired

Document Identifier

Query Parameters

siteId string

Site Identifier

application/json

Body

required

attributes

object[]

List of document attributes

Array [

oneOf

AddDocumentAttributeStandard

Document Attribute

key stringrequired

Attribute key

stringValue string

Attribute with string value

stringValues string[]

Attribute with string values

numberValue number

Attribute with number value

numberValues number[]

Attribute with number values

booleanValue boolean

Attribute with boolean value

AddDocumentAttributeClassification

Document Classification

classificationId stringrequired

Classification Identifier

AddDocumentAttributeRelationship

Document Relationship

documentId stringrequired

Relationship To Document Identifier

relationship DocumentRelationshipType (string)required

Document Relationship Type

Possible values: [PRIMARY, ATTACHMENT, APPENDIX, SUPPLEMENT, ASSOCIATED, RENDITION]

inverseRelationship DocumentRelationshipType (string)

Document Relationship Type

Possible values: [PRIMARY, ATTACHMENT, APPENDIX, SUPPLEMENT, ASSOCIATED, RENDITION]

]

Responses

200

200 OK

Response Headers

• Access-Control-Allow-Origin

  string

• Access-Control-Allow-Methods

  string

• Access-Control-Allow-Headers

  string

application/json

Schema

Schema

message string

Result message

Example (from schema)

{
  "message": "string"
}

Loading...