TRANXACT.AI Help

Talent & Contingent Workforce · Services and actions

Boards

The boards service of Talent & Contingent Workforce: 9 operation(s).

Type REST9 operationsBase path /api/ats/boards

Download specification (OpenAPI 3.1)

Overview

PackageTalent & Contingent Workforce
AuthenticationBearer token: a service account's token (POST /api/auth/service-token) or, for the published path, an API key
AuthorizationThe caller's roles must hold Talent & Contingent Workforce › Boards 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.
RulesThe same as the screen: validation, numbering, approvals, posting, the company the caller belongs to, and the audit trail.

API reference

9 operations. Open one for its parameters, bodies, responses and a sample request.

GET/api/ats/boards/catalogCatalog

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/ats/boards/catalog" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/boards/advertiseAdvertise

Request body

The keys this action reads (* = required; "one of" lists the only values):

title, description, location, confidential, displayCompany, skills, jobOrderId*, connectionIds, durationDays

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/ats/boards/advertise" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"title":"value","description":"value","location":"value","confidential":"value","displayCompany":"value","skills":"value"}'
GET/api/ats/boards/feed/{token}Feed

Path parameters

NameTypeDescription
tokenstring (uuid)The record's token, as a list returns it.

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/ats/boards/feed/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/boards/postings/{id}/closePostings close

Path parameters

NameTypeDescription
idstring (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/ats/boards/postings/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/close" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/boards/applications/{id}/convertApplications convert

Path parameters

NameTypeDescription
idstring (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/ats/boards/applications/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/convert" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ats/boards/inboxInbox

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/ats/boards/inbox" \
  -H "Authorization: Bearer $TOKEN"
POST/api/ats/boards/alerts/{id}/armAlerts arm

Path parameters

NameTypeDescription
idstring (uuid)The record's id, as a list returns it.

Request body

The keys this action reads (* = required; "one of" lists the only values):

active

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/ats/boards/alerts/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/arm" \
  -H "Authorization: Bearer $TOKEN" \
  -H "Content-Type: application/json" \
  -d '{"active":"value"}'
POST/api/ats/boards/alert-hits/{id}/matchAlert hits match

Path parameters

NameTypeDescription
idstring (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/ats/boards/alert-hits/3f1c2a9e-5b7d-4c1e-9a2f-0d4b8e6c1a73/match" \
  -H "Authorization: Bearer $TOKEN"
GET/api/ats/boards/overviewOverview

Response

200 with the data as JSON.

Sample request

curl "https://demo.tranxact.ai/api/ats/boards/overview" \
  -H "Authorization: Bearer $TOKEN"

Errors

StatusMeaning
400The request could not be read: a filter that is not JSON, a bad parameter
401No credential, or it is wrong, revoked or expired
403The caller's roles do not hold Talent & Contingent Workforce › Boards for this verb, or the address or origin is not allowed
404No record with that id is visible to the caller
409A conflict: a duplicate number, a document in a state that does not allow it, or a record changed or locked by someone else
422Refused 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.