Documents_update
PATCH/documents/:id
Updates a Datasphere Document by ID
Request
Path Parameters
id uuidrequired
Unique ID of a Document.
- application/json
Body
required
tags string[]
Document tags.
Responses
- 200
- 401
- 404
- 422
The request has succeeded.
- application/json
- Schema
- Example (from schema)
Schema
id uuidrequired
Unique ID of a Document.
filename stringrequired
Name of the Document.
status DocumentStatus (string)required
Possible values: [submitted
, in_progress
, completed
, failed
]
The current Status of the Document.
tags string[]required
Document tags.
number_of_chunks integerrequired
Number of Chunks in the Document.
created_at date-timerequired
Document Creation Date.
updated_at date-timerequired
Document Update Date.
{
"id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
"filename": "player_list.pdf",
"status": "submitted",
"tags": [
"sports",
"football",
"game"
],
"number_of_chunks": 2345,
"created_at": "2024-05-06T12:20-12Z",
"updated_at": "2024-05-06T12:20-12Z"
}
Access is unauthorized.
- application/json
- Schema
Schema
string
Possible values: [Unauthorized
]
The server cannot find the requested resource.
- application/json
- Schema
Schema
string
Possible values: [Not Found
]
Client error
- application/json
- Schema
- Example (from schema)
Schema
Array [
]
errors
object[]
required
type stringrequired
Error type.
code stringrequired
Error code.
message stringrequired
Error details.
attribute stringrequired
Request parameter associated with this error.
url stringrequired
Link to developer resource for this error.
{
"errors": [
{
"type": "validation_error",
"code": "invalid_parameter",
"message": "Invalid tags",
"attribute": "tags",
"url": "https://developer.signalwire.com/rest/overview/error-codes#{code}"
}
]
}
Loading...