Jump to

• Request
• Response

Patch details of a candidate work preference

patch

/hcmRestApi/resources/11.13.18.05/recruitingCECandidateWorkPreferences/{WorkPreferenceId}

Request

Path Parameters

• WorkPreferenceId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• AllLocationsFlag: boolean
  Title: All Locations

  Maximum Length: 30

  Indicates that the candidate has selected all locations.
• Comments: string (byte)
  Title: Comments

  Comments in the candidate work preferences.
• ContentItemId: integer (int64)
  ContentItemId in the candidate work preferences.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 30

  Currency code in the candidate work preferences.
• DateFrom: string (date)
  Date from in the candidate work preferences.
• DateTo: string (date)
  Date to in the candidate work preferences.
• ExcludedLocationId1: integer (int64)
  Title: First Excluded Location

  Excluded Location Id 1 in the candidate work preferences.
• ExcludedLocationId2: integer (int64)
  Title: Second Excluded Location

  Excluded Location Id 2 in the candidate work preferences.
• ExcludedLocationId3: integer (int64)
  Title: Third Excluded Location

  Excluded Location Id 3 in the candidate work preferences.
• ExcludedLocationId4: integer (int64)
  Title: Fourth Excluded Location

  Excluded Location Id 4 in the candidate work preferences.
• FlexibleWorkFlag: boolean
  Title: Work a Flexible Schedule

  Maximum Length: 30

  Indicates that the candidate has opted for flexible work hours.
• FlowVersionId: integer
  Flow version ID in the candidate work preferences.
• FullTimeEquivalent: number
  Title: Full Time Equivalent

  Full time equivalent in the candidate work preferences.
• IntlTravelFlag: boolean
  Title: Travel Internationally

  Maximum Length: 30

  Indicates that the candidate has opted for international travel.
• IntlTravelFrequency: string
  Title: International Travel Frequency

  Maximum Length: 30

  International Travel Frequency in candidate work preferences.
• IntlTravelRequiredFlag: boolean
  Title: International Travel Required

  Maximum Length: 30

  Indicates that the candidate is ready for international travel.
• MinimumPay: integer (int64)
  Title: Minimum Pay

  Minimum pay in candidate work preferences.
• NatTravelFlag: boolean
  Title: Travel Domestically

  Maximum Length: 30

  Indicates that the candidate has opted for domestic travel.
• NatTravelFrequency: string
  Title: Domestic Travel Frequency

  Maximum Length: 30

  National travel frequency in the candidate work preferences.
• NatTravelRequiredFlag: boolean
  Title: Travel Required

  Maximum Length: 30

  Indicates that the candidate is ready for domestic travel.
• PartAssignFlag: boolean
  Title: Consider Part Time Work

  Maximum Length: 30

  Indicates that the candidate has opted for part payment.
• PayFrequency: string
  Title: Pay Frequency

  Maximum Length: 30

  Pay frequency in the candidate work preferences.
• PayRange: string
  Title: Pay Range

  Maximum Length: 30

  Pay range in the candidate work preferences.
• PreferredLocationId1: integer (int64)
  Title: First Preferred Location

  Preferred location Id 1 in the candidate work preferences.
• PreferredLocationId2: integer (int64)
  Title: Second Preferred Location

  Preferred location Id 2 in the candidate work preferences.
• PreferredLocationId3: integer (int64)
  Title: Third Preferred Location

  Preferred location Id 3 in the candidate work preferences.
• PreferredLocationId4: integer (int64)
  Title: Fourth Preferred Location

  Preferred location Id 4 in the candidate work preferences.
• RelocateDuration: integer (int64)
  Title: Length of Willing to Relocate

  Duration required by the candidate to relocate.
• RelocateFlag: boolean
  Title: Willing to Relocate

  Maximum Length: 30

  Indicates that the candidate is ready to relocate.
• RelocationReason: string
  Title: Relocation Reason

  Maximum Length: 240

  Relocation reason in the candidate work preferences.
• SectionId: integer (int64)
  Section ID in the candidate work preferences.
• SubmissionId: string
  Submission ID in the candidate work preferences.
• TempAssignFlag: boolean
  Title: Consider Temporary Assignment

  Maximum Length: 30

  Indicates temporary assignment in the candidate work preferences.
• WorkDays: string
  Title: Workdays

  Maximum Length: 30

  Workdays in the candidate work preferences.
• WorkHours: string
  Title: Work Hours

  Maximum Length: 30

  Work hours in the candidate work preferences.
• WorkMonths: integer (int64)
  Title: Work Duration Months

  Work months in the candidate work preferences.
• WorkYears: integer (int64)
  Title: Work Duration Years

  Work years in the candidate work preferences.

{
    "type":"object",
    "properties":{
        "AllLocationsFlag":{
            "title":"All Locations",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates that the candidate has selected all locations.",
            "nullable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments in the candidate work preferences.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ContentItemId":{
            "type":"integer",
            "description":"ContentItemId in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":30,
            "type":"string",
            "description":"Currency code in the candidate work preferences.",
            "nullable":true
        },
        "DateFrom":{
            "type":"string",
            "description":"Date from in the candidate work preferences.",
            "format":"date",
            "nullable":false
        },
        "DateTo":{
            "type":"string",
            "description":"Date to in the candidate work preferences.",
            "format":"date",
            "nullable":true
        },
        "ExcludedLocationId1":{
            "title":"First Excluded Location",
            "type":"integer",
            "description":"Excluded Location Id 1 in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ExcludedLocationId2":{
            "title":"Second Excluded Location",
            "type":"integer",
            "description":"Excluded Location Id 2 in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ExcludedLocationId3":{
            "title":"Third Excluded Location",
            "type":"integer",
            "description":"Excluded Location Id 3 in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ExcludedLocationId4":{
            "title":"Fourth Excluded Location",
            "type":"integer",
            "description":"Excluded Location Id 4 in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "FlexibleWorkFlag":{
            "title":"Work a Flexible Schedule",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates that the candidate has opted for flexible work hours.",
            "nullable":true
        },
        "FlowVersionId":{
            "type":"integer",
            "description":"Flow version ID in the candidate work preferences.",
            "nullable":true
        },
        "FullTimeEquivalent":{
            "title":"Full Time Equivalent",
            "type":"number",
            "description":"Full time equivalent in the candidate work preferences.",
            "nullable":true,
            "x-hints":{
                "precision":15,
                "scale":2
            }
        },
        "IntlTravelFlag":{
            "title":"Travel Internationally",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates that the candidate has opted for international travel.",
            "nullable":true
        },
        "IntlTravelFrequency":{
            "title":"International Travel Frequency",
            "maxLength":30,
            "type":"string",
            "description":"International Travel Frequency in candidate work preferences.",
            "nullable":true
        },
        "IntlTravelRequiredFlag":{
            "title":"International Travel Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates that the candidate is ready for international travel.",
            "nullable":true
        },
        "MinimumPay":{
            "title":"Minimum Pay",
            "type":"integer",
            "description":"Minimum pay in candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "NatTravelFlag":{
            "title":"Travel Domestically",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates that the candidate has opted for domestic travel.",
            "nullable":true
        },
        "NatTravelFrequency":{
            "title":"Domestic Travel Frequency",
            "maxLength":30,
            "type":"string",
            "description":"National travel frequency in the candidate work preferences.",
            "nullable":true
        },
        "NatTravelRequiredFlag":{
            "title":"Travel Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates that the candidate is ready for domestic travel.",
            "nullable":true
        },
        "PartAssignFlag":{
            "title":"Consider Part Time Work",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates that the candidate has opted for part payment.",
            "nullable":true
        },
        "PayFrequency":{
            "title":"Pay Frequency",
            "maxLength":30,
            "type":"string",
            "description":"Pay frequency in the candidate work preferences.",
            "nullable":true
        },
        "PayRange":{
            "title":"Pay Range",
            "maxLength":30,
            "type":"string",
            "description":"Pay range in the candidate work preferences.",
            "nullable":true
        },
        "PreferredLocationId1":{
            "title":"First Preferred Location",
            "type":"integer",
            "description":"Preferred location Id 1 in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PreferredLocationId2":{
            "title":"Second Preferred Location",
            "type":"integer",
            "description":"Preferred location Id 2 in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PreferredLocationId3":{
            "title":"Third Preferred Location",
            "type":"integer",
            "description":"Preferred location Id 3 in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PreferredLocationId4":{
            "title":"Fourth Preferred Location",
            "type":"integer",
            "description":"Preferred location Id 4 in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RelocateDuration":{
            "title":"Length of Willing to Relocate",
            "type":"integer",
            "description":"Duration required by the candidate to relocate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "RelocateFlag":{
            "title":"Willing to Relocate",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates that the candidate is ready to relocate.",
            "nullable":true
        },
        "RelocationReason":{
            "title":"Relocation Reason",
            "maxLength":240,
            "type":"string",
            "description":"Relocation reason in the candidate work preferences.",
            "nullable":true
        },
        "SectionId":{
            "type":"integer",
            "description":"Section ID in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SubmissionId":{
            "type":"string",
            "description":"Submission ID in the candidate work preferences.",
            "nullable":true
        },
        "TempAssignFlag":{
            "title":"Consider Temporary Assignment",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates temporary assignment in the candidate work preferences.",
            "nullable":true
        },
        "WorkDays":{
            "title":"Workdays",
            "maxLength":30,
            "type":"string",
            "description":"Workdays in the candidate work preferences.",
            "nullable":true
        },
        "WorkHours":{
            "title":"Work Hours",
            "maxLength":30,
            "type":"string",
            "description":"Work hours in the candidate work preferences.",
            "nullable":true
        },
        "WorkMonths":{
            "title":"Work Duration Months",
            "type":"integer",
            "description":"Work months in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "WorkYears":{
            "title":"Work Duration Years",
            "type":"integer",
            "description":"Work years in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : recruitingCECandidateWorkPreferences-item-response

Type: object

Show Source

• AllLocationsFlag: boolean
  Title: All Locations

  Maximum Length: 30

  Indicates that the candidate has selected all locations.
• Comments: string (byte)
  Title: Comments

  Comments in the candidate work preferences.
• ContentItemId: integer (int64)
  ContentItemId in the candidate work preferences.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 30

  Currency code in the candidate work preferences.
• DateFrom: string (date)
  Date from in the candidate work preferences.
• DateTo: string (date)
  Date to in the candidate work preferences.
• ExcludedLocationId1: integer (int64)
  Title: First Excluded Location

  Excluded Location Id 1 in the candidate work preferences.
• ExcludedLocationId2: integer (int64)
  Title: Second Excluded Location

  Excluded Location Id 2 in the candidate work preferences.
• ExcludedLocationId3: integer (int64)
  Title: Third Excluded Location

  Excluded Location Id 3 in the candidate work preferences.
• ExcludedLocationId4: integer (int64)
  Title: Fourth Excluded Location

  Excluded Location Id 4 in the candidate work preferences.
• FlexibleWorkFlag: boolean
  Title: Work a Flexible Schedule

  Maximum Length: 30

  Indicates that the candidate has opted for flexible work hours.
• FlowVersionId: integer
  Flow version ID in the candidate work preferences.
• FullTimeEquivalent: number
  Title: Full Time Equivalent

  Full time equivalent in the candidate work preferences.
• IntlTravelFlag: boolean
  Title: Travel Internationally

  Maximum Length: 30

  Indicates that the candidate has opted for international travel.
• IntlTravelFrequency: string
  Title: International Travel Frequency

  Maximum Length: 30

  International Travel Frequency in candidate work preferences.
• IntlTravelRequiredFlag: boolean
  Title: International Travel Required

  Maximum Length: 30

  Indicates that the candidate is ready for international travel.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MinimumPay: integer (int64)
  Title: Minimum Pay

  Minimum pay in candidate work preferences.
• NatTravelFlag: boolean
  Title: Travel Domestically

  Maximum Length: 30

  Indicates that the candidate has opted for domestic travel.
• NatTravelFrequency: string
  Title: Domestic Travel Frequency

  Maximum Length: 30

  National travel frequency in the candidate work preferences.
• NatTravelRequiredFlag: boolean
  Title: Travel Required

  Maximum Length: 30

  Indicates that the candidate is ready for domestic travel.
• PartAssignFlag: boolean
  Title: Consider Part Time Work

  Maximum Length: 30

  Indicates that the candidate has opted for part payment.
• PayFrequency: string
  Title: Pay Frequency

  Maximum Length: 30

  Pay frequency in the candidate work preferences.
• PayRange: string
  Title: Pay Range

  Maximum Length: 30

  Pay range in the candidate work preferences.
• PreferredLocationId1: integer (int64)
  Title: First Preferred Location

  Preferred location Id 1 in the candidate work preferences.
• PreferredLocationId2: integer (int64)
  Title: Second Preferred Location

  Preferred location Id 2 in the candidate work preferences.
• PreferredLocationId3: integer (int64)
  Title: Third Preferred Location

  Preferred location Id 3 in the candidate work preferences.
• PreferredLocationId4: integer (int64)
  Title: Fourth Preferred Location

  Preferred location Id 4 in the candidate work preferences.
• RelocateDuration: integer (int64)
  Title: Length of Willing to Relocate

  Duration required by the candidate to relocate.
• RelocateFlag: boolean
  Title: Willing to Relocate

  Maximum Length: 30

  Indicates that the candidate is ready to relocate.
• RelocationReason: string
  Title: Relocation Reason

  Maximum Length: 240

  Relocation reason in the candidate work preferences.
• SectionId: integer (int64)
  Section ID in the candidate work preferences.
• SubmissionId: string
  Submission ID in the candidate work preferences.
• TempAssignFlag: boolean
  Title: Consider Temporary Assignment

  Maximum Length: 30

  Indicates temporary assignment in the candidate work preferences.
• WorkDays: string
  Title: Workdays

  Maximum Length: 30

  Workdays in the candidate work preferences.
• WorkHours: string
  Title: Work Hours

  Maximum Length: 30

  Work hours in the candidate work preferences.
• WorkMonths: integer (int64)
  Title: Work Duration Months

  Work months in the candidate work preferences.
• WorkPreferenceId: integer (int64)
  Work preference ID in the candidate work preferences.
• WorkYears: integer (int64)
  Title: Work Duration Years

  Work years in the candidate work preferences.

{
    "type":"object",
    "properties":{
        "AllLocationsFlag":{
            "title":"All Locations",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates that the candidate has selected all locations.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments in the candidate work preferences.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "ContentItemId":{
            "type":"integer",
            "description":"ContentItemId in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":30,
            "type":"string",
            "description":"Currency code in the candidate work preferences.",
            "nullable":true,
            "x-queryable":true
        },
        "DateFrom":{
            "type":"string",
            "description":"Date from in the candidate work preferences.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "DateTo":{
            "type":"string",
            "description":"Date to in the candidate work preferences.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ExcludedLocationId1":{
            "title":"First Excluded Location",
            "type":"integer",
            "description":"Excluded Location Id 1 in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExcludedLocationId2":{
            "title":"Second Excluded Location",
            "type":"integer",
            "description":"Excluded Location Id 2 in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExcludedLocationId3":{
            "title":"Third Excluded Location",
            "type":"integer",
            "description":"Excluded Location Id 3 in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExcludedLocationId4":{
            "title":"Fourth Excluded Location",
            "type":"integer",
            "description":"Excluded Location Id 4 in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FlexibleWorkFlag":{
            "title":"Work a Flexible Schedule",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates that the candidate has opted for flexible work hours.",
            "nullable":true,
            "x-queryable":true
        },
        "FlowVersionId":{
            "type":"integer",
            "description":"Flow version ID in the candidate work preferences.",
            "nullable":true,
            "x-queryable":true
        },
        "FullTimeEquivalent":{
            "title":"Full Time Equivalent",
            "type":"number",
            "description":"Full time equivalent in the candidate work preferences.",
            "nullable":true,
            "x-hints":{
                "precision":15,
                "scale":2
            },
            "x-queryable":true
        },
        "IntlTravelFlag":{
            "title":"Travel Internationally",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates that the candidate has opted for international travel.",
            "nullable":true,
            "x-queryable":true
        },
        "IntlTravelFrequency":{
            "title":"International Travel Frequency",
            "maxLength":30,
            "type":"string",
            "description":"International Travel Frequency in candidate work preferences.",
            "nullable":true,
            "x-queryable":true
        },
        "IntlTravelRequiredFlag":{
            "title":"International Travel Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates that the candidate is ready for international travel.",
            "nullable":true,
            "x-queryable":true
        },
        "MinimumPay":{
            "title":"Minimum Pay",
            "type":"integer",
            "description":"Minimum pay in candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "NatTravelFlag":{
            "title":"Travel Domestically",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates that the candidate has opted for domestic travel.",
            "nullable":true,
            "x-queryable":true
        },
        "NatTravelFrequency":{
            "title":"Domestic Travel Frequency",
            "maxLength":30,
            "type":"string",
            "description":"National travel frequency in the candidate work preferences.",
            "nullable":true,
            "x-queryable":true
        },
        "NatTravelRequiredFlag":{
            "title":"Travel Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates that the candidate is ready for domestic travel.",
            "nullable":true,
            "x-queryable":true
        },
        "PartAssignFlag":{
            "title":"Consider Part Time Work",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates that the candidate has opted for part payment.",
            "nullable":true,
            "x-queryable":true
        },
        "PayFrequency":{
            "title":"Pay Frequency",
            "maxLength":30,
            "type":"string",
            "description":"Pay frequency in the candidate work preferences.",
            "nullable":true,
            "x-queryable":true
        },
        "PayRange":{
            "title":"Pay Range",
            "maxLength":30,
            "type":"string",
            "description":"Pay range in the candidate work preferences.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferredLocationId1":{
            "title":"First Preferred Location",
            "type":"integer",
            "description":"Preferred location Id 1 in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreferredLocationId2":{
            "title":"Second Preferred Location",
            "type":"integer",
            "description":"Preferred location Id 2 in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreferredLocationId3":{
            "title":"Third Preferred Location",
            "type":"integer",
            "description":"Preferred location Id 3 in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreferredLocationId4":{
            "title":"Fourth Preferred Location",
            "type":"integer",
            "description":"Preferred location Id 4 in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelocateDuration":{
            "title":"Length of Willing to Relocate",
            "type":"integer",
            "description":"Duration required by the candidate to relocate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "RelocateFlag":{
            "title":"Willing to Relocate",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates that the candidate is ready to relocate.",
            "nullable":true,
            "x-queryable":true
        },
        "RelocationReason":{
            "title":"Relocation Reason",
            "maxLength":240,
            "type":"string",
            "description":"Relocation reason in the candidate work preferences.",
            "nullable":true,
            "x-queryable":true
        },
        "SectionId":{
            "type":"integer",
            "description":"Section ID in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SubmissionId":{
            "type":"string",
            "description":"Submission ID in the candidate work preferences.",
            "nullable":true,
            "x-queryable":true
        },
        "TempAssignFlag":{
            "title":"Consider Temporary Assignment",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates temporary assignment in the candidate work preferences.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkDays":{
            "title":"Workdays",
            "maxLength":30,
            "type":"string",
            "description":"Workdays in the candidate work preferences.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkHours":{
            "title":"Work Hours",
            "maxLength":30,
            "type":"string",
            "description":"Work hours in the candidate work preferences.",
            "nullable":true,
            "x-queryable":true
        },
        "WorkMonths":{
            "title":"Work Duration Months",
            "type":"integer",
            "description":"Work months in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkPreferenceId":{
            "type":"integer",
            "description":"Work preference ID in the candidate work preferences.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "WorkYears":{
            "title":"Work Duration Years",
            "type":"integer",
            "description":"Work years in the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  The name of the relation to the resource instance. Example: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top