v1

latestOpenAPI 3.0.12026-07-243124341009.5 KB

Companies

Add Universal Company Restriction

Adds a talent to the 'Do Not Assign' list universally across multiple tenants for specified companies.

post/v1/company-restrictions/add-universal-restriction

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.

Request body

talentIdinteger required

The identifier for the talent.

restrictedByUserIdinteger required

The user identifier who is adding the restriction.

dnaDatestring date-time

The date when the restriction was added. Defaults to current date if null. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

dnaNotesstring

Any additional notes regarding the restriction.

Example request

{
  "talentId": 138344,
  "tenantCompanies": [
    {
      "tenantId": 796,
      "companyIds": [
        12345,
        67890
      ]
    }
  ],
  "restrictedByUserId": 18994,
  "dnaNotes": "This is a sample note."
}

Response

The response containing the details of the added universal company restrictions.

talentIdinteger

The identifier for the talent.

restrictedByUserIdinteger

The identifier for the user who added the restriction.

dnaDatestring date-time

The date when restriction was added. The field follows the YYYY-MM-DD or YYYY-MM-DDTHH:mm:ss formats and also supports fractional seconds, such as YYYY-MM-DDTHH:mm:ss.sss. For example, 2024-12-01, 2024-12-01T14:30:00, and 2024-12-01T14:30:00.546.

dnaNotesstring

The notes for the restriction.

errorsstring[]

A list of error messages, if any.

Example response

{
  "talentId": 18394,
  "tenantCompanies": [
    {
      "tenantId": 796,
      "companyIds": [
        12345,
        67890
      ]
    }
  ],
  "restrictedByUserId": 12345,
  "dnaNotes": "This is a sample note.",
  "errors": [
    "Error 1",
    "Error 2"
  ]
}