Update Attached Document partially
  • 28 Aug 2024
  • 1 Minute to read
  • Contributors
  • Dark
    Light
  • PDF

Update Attached Document partially

  • Dark
    Light
  • PDF

Article summary

Patch
/attached-docs/{id}/

Operation is used to update specific fields in existing Attached Document. Available from product version 3.2.8.

Security
API Key
Header parameter nameAuthorization

Token issued for API consumer.

Path parameters
id
integerRequired

Id of Attached Document to update

Body parameters

Attached Document properties and values to be updated

object
attachedObjectType
integer Required

<<_objecttype>> id of the object attached to the document. It is unique id which determines type of the target object. <<_getobjecttypes>>

documentId
integer

Id of external document attached to the object

target
integer

Id of the object attached to the document

Responses
200

Object was updated successfully

object
createdBy
string

creator

createdTs
string (date-time)

Creation date and time

documentId
integer

Id of external document attached to the object

id
integer

Unique id of Attached Document

target
integer

Id of the object attached to the document

401

Authentication credentials are missing or invalid

{
  "details": "Authentication credentials were not provided"
}
object
details
string

Detailed description of error

404

Object was not found

{
  "details": "Not found."
}
object
details
string

Detailed description of error


Was this article helpful?