Sign in

v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB
Talent

Get Talent Documents

Returns a list of documents for the specified talent.

get/v1/talent/{talentId}/document

Path parameters

talentIdstring required

The identifier for the talent whose documents are being retrieved.

Headers

RequestIdstring uuid

The unique request identifier used to correlate request data with log entries and events, formatted as a UUID.

Unique request identifier (UUID) used to correlate request data with log entries and events.

FrontOfficeTenantIdinteger

An integer identifier for the tenant that the request is being made for. Required when Tenant header is not provided.

Tenantstring

Tenant company code that determines data access scope during the request. Required when FrontOfficeTenantId header is not provided.

Response

The list of documents for the specified talent.

idinteger

The identifier for the talent document.

talentIdinteger

The identifier for the talent.

fileNamestring

The encrypted name of the file with extension that is generated by Avionté.

fileContentstring binary

The content of the file to be uploaded. It will be populated using the content of the attached file. Valid file extensions are: 'txt', 'doc', 'docx', 'pdf', 'xls', 'xlsx', 'png', 'jpg', 'jpeg'.

documentTitlestring

The title of the document.

documentDatestring date-time

The date when the document was uploaded. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.

documentTypestring

The type of the BOLD document.

uploadedByinteger

The ID of the user who uploaded the document.

isPrivateboolean

An indication of whether the document is private or not.

isSharedboolean

An indication of whether the document is shared or not.

expiryDatestring date-time

The expiration date of the document. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats, for example, 2024-12-01 or 2024-12-01T14:30:00.

documentTypeIdinteger

The identifier for the BOLD document type.

employerIdinteger

The identifier for the employer.

isVisibleboolean

An indication of whether the document is visible or not.

documentContentstring byte

The contents of the talent document as a Base-64 encoded string.

Example response

[
  {
    "id": 28925,
    "talentId": 1328925,
    "fileName": "5jBlQJ8WSqJ67dNSMxLBDy2f.docx",
    "documentTitle": "John Doe Resume.docx",
    "documentType": "Resume",
    "uploadedBy": 123948,
    "isShared": true,
    "documentTypeId": 59245,
    "employerId": 234,
    "isVisible": true
  }
]