Get Attached Document details
- 28 Aug 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Get Attached Document details
- Updated on 28 Aug 2024
- 1 Minute to read
- Contributors
- Print
- DarkLight
- PDF
Article summary
Did you find this summary helpful?
Thank you for your feedback
Get
/attached-docs/{id}/
Operation is used to retrieve full details of attachment between given attached object type and document by id. 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
Query parameters
attachedObjectType
integerRequired
<<_objecttype>> id of the object attached to the document. It is unique id which determines type of the target object. <<_getobjecttypes>>
Responses
200
Attached Document
{
"attachedObjectType": {
"id": 888,
"identifier": "objectidentifier",
"instanceAPIUrl": "https://example.keycom.com/api/v2/object/",
"name": "Objectname",
"objectTypesUrl": "https://example.keycom.com/api/v2/objecttypes/"
},
"createdBy": "USER",
"createdTs": "2020-06-05T11:23:42Z",
"documentId": 88547,
"documentUrl": "https://example.keycom.com/api/v2/externaldoc/88547/",
"id": 3352794,
"target": "https://example.keycom.com/api/v2/object/4040485/"
}object
Attached Document
attachedObjectType
object (ObjectType)
id
integer
Primary key
identifier
string
Object type readable identifier
instanceAPIUrl
string (url)
Object type instances API endpoint URL.
name
string
Object type translated name. Not searchable.
objectTypesUrl
string (url)
Url to fetch all object types.
createdBy
string
creator
createdTs
string (date-time)
Creation date and time
documentId
integer
Unique identifier of attached external document
documentUrl
string (url)
Url to fetch attached external document
id
integer
Unique id of Attached Document
target
string (url)
Url to fetch attached object
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?
