Platform · Services and actions
Content
The content service of Platform: 11 operation(s).
/api/platform/contentOverview
| Package | Platform |
|---|---|
| Authentication | Bearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key |
| Authorization | The caller's roles must hold Platform › Content on the Roles screen: display for GET, add for POST, change for PUT, delete for DELETE; an action needs the grant of the button that runs it on the screen. |
| Rules | The same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail. |
API reference
11 operations. Open one for its parameters, bodies, responses and a sample request.
GET/api/platform/content/providersProviders
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/content/providers" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/content/sources/{id}Sources
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/content/sources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/content/sourcesSources
Request body
The keys this action reads (* = required; "one of" lists the only values):
code, provider*, name, config, root_path, modules, max_file_mb, auth_typeResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/content/sources" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"code":"value","provider":"value","name":"value","config":"value","root_path":"value","modules":"value"}'PUT/api/platform/content/sources/{id}Sources
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
Request body
The keys this action reads (* = required; "one of" lists the only values):
configResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/content/sources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"config":"value"}'DELETE/api/platform/content/sources/{id}Sources
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X DELETE "https://demo.tranxact.ai/api/platform/content/sources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
-H "Authorization: Bearer $TOKEN"POST/api/platform/content/sources/{id}/testSources test
Path parameters
| Name | Type | Description |
|---|---|---|
id | string (uuid) | The record's id, as a list returns it. |
No body is required.
Response
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X POST "https://demo.tranxact.ai/api/platform/content/sources/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/test" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/content/scan-policyScan policy
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/content/scan-policy" \
-H "Authorization: Bearer $TOKEN"PUT/api/platform/content/scan-policyScan policy
Request body
The keys this action reads (* = required; "one of" lists the only values):
clamav_enabled, clamav_hostResponse
200 or 201 with the record or result as JSON; a refusal is 409 or 422 with a sentence saying why.
Sample request
curl -X PUT "https://demo.tranxact.ai/api/platform/content/scan-policy" \
-H "Authorization: Bearer $TOKEN" \
-H "Content-Type: application/json" \
-d '{"clamav_enabled":"value","clamav_host":"value"}'GET/api/platform/content/inboxInbox
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/content/inbox" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/content/reports/attachmentsReports attachments
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/content/reports/attachments" \
-H "Authorization: Bearer $TOKEN"GET/api/platform/content/reports/suggestionsReports suggestions
Response
200 with the data as JSON.
Sample request
curl "https://demo.tranxact.ai/api/platform/content/reports/suggestions" \
-H "Authorization: Bearer $TOKEN"Errors
| Status | Meaning |
|---|---|
| 400 | The request could not be read: a filter that is not JSON, a bad parameter |
| 401 | No credential, or it is wrong, revoked or expired |
| 403 | The caller's roles do not hold Platform › Content for this verb, or the address or origin is not allowed |
| 404 | No record with that id is visible to the caller |
| 409 | A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else |
| 422 | Refused by the same validation as the screen; the error names the field and why |
Every error is JSON: {"error": "a sentence saying what was wrong"}, with field where it applies.