Jump to

• Request
• Response

Update a candidate work preference

patch

/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/workPreferences/{WorkPreferenceId}

Request

Path Parameters

• CandidateNumber(required): string
  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=
• 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:
  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.

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 whether all locations are included in the candidate work preferences.
• Comments: string (byte)
  Title: Comments

  Comments of the candidate work preferences.
• ContentItemId: integer (int64)
  Content item identifier of the candidate work preferences.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 30

  Currency code of the candidate work preferences.
• DateFrom: string (date)
  Date from of the candidate work preferences.
• DateTo: string (date)
  Date to of the candidate work preferences.
• ExcludedLocationFourId: integer (int64)
  Title: Fourth Excluded Location

  Excluded location four identifier of the candidate work preferences.
• ExcludedLocationOneId: integer (int64)
  Title: First Excluded Location

  Excluded location one identifier of the candidate work preferences.
• ExcludedLocationThreeId: integer (int64)
  Title: Third Excluded Location

  Excluded location three identifier of the candidate work preferences.
• ExcludedLocationTwoId: integer (int64)
  Title: Second Excluded Location

  Excluded location two identifier of the candidate work preferences.
• FlexibleWorkFlag: boolean
  Title: Work a Flexible Schedule

  Maximum Length: 30

  Indicates whether flexible work is required in the candidate work preferences.
• FullTimeEquivalent: number
  Title: Full Time Equivalent

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

  Maximum Length: 30

  Indicates whether international travel is in the candidate work preferences.
• IntlTravelFrequency: string
  Title: International Travel Frequency

  Maximum Length: 30

  International travel frequency of the candidate work preferences.
• IntlTravelRequiredFlag: boolean
  Title: International Travel Required

  Maximum Length: 30

  Indicates whether international travel is required in the candidate work preferences.
• MinimumPay: integer (int64)
  Title: Minimum Pay

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

  Maximum Length: 30

  Indicates whether domestic travel is in the candidate work preferences.
• NatTravelFrequency: string
  Title: Domestic Travel Frequency

  Maximum Length: 30

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

  Maximum Length: 30

  Indicates whether domestic travel is required in the candidate work preferences.
• PartAssignFlag: boolean
  Title: Consider Part Time Work

  Maximum Length: 30

  Part assign indicator of the candidate work preferences.
• PayFrequency: string
  Title: Pay Frequency

  Maximum Length: 30

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

  Maximum Length: 30

  Pay range of the candidate work preferences.
• PreferredLocationFourId: integer (int64)
  Title: Fourth Preferred Location

  Preferred location four identifier of the candidate work preferences.
• PreferredLocationOneId: integer (int64)
  Title: First Preferred Location

  Preferred location one identifier of the candidate work preferences.
• PreferredLocationThreeId: integer (int64)
  Title: Third Preferred Location

  Preferred location three identifier of the candidate work preferences.
• PreferredLocationTwoId: integer (int64)
  Title: Second Preferred Location

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

  Relocate duration of the candidate work preferences.
• RelocateFlag: boolean
  Title: Willing to Relocate

  Maximum Length: 30

  Indicates whether relocation is possible in the candidate work preferences.
• RelocationReason: string
  Title: Relocation Reason

  Maximum Length: 240

  Relocation reason of the candidate work preferences.
• SectionId: integer (int64)
  Section identifier of the candidate work preferences.
• TempAssignFlag: boolean
  Title: Consider Temporary Assignment

  Maximum Length: 30

  Indicates whether temporary assignment is in the candidate work preferences.
• WorkDays: string
  Title: Work Days

  Maximum Length: 30

  Work days of the candidate work preferences.
• WorkHours: string
  Title: Work Hours

  Maximum Length: 30

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

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

  Work years of the candidate work preferences.

{
    "type":"object",
    "properties":{
        "NatTravelRequiredFlag":{
            "title":"Travel Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether domestic travel is required in the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "FlexibleWorkFlag":{
            "title":"Work a Flexible Schedule",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether flexible work is required in the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "NatTravelFlag":{
            "title":"Travel Domestically",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether domestic travel is in the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "RelocateFlag":{
            "title":"Willing to Relocate",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether relocation is possible in the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkDays":{
            "title":"Work Days",
            "maxLength":30,
            "type":"string",
            "description":"Work days of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "ExcludedLocationTwoId":{
            "title":"Second Excluded Location",
            "type":"integer",
            "description":"Excluded location two identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "NatTravelFrequency":{
            "title":"Domestic Travel Frequency",
            "maxLength":30,
            "type":"string",
            "description":"National travel frequency of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "AllLocationsFlag":{
            "title":"All Locations",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether all locations are included in the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":30,
            "type":"string",
            "description":"Currency code of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "ContentItemId":{
            "type":"integer",
            "description":"Content item identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PayFrequency":{
            "title":"Pay Frequency",
            "maxLength":30,
            "type":"string",
            "description":"Pay frequency of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "PayRange":{
            "title":"Pay Range",
            "maxLength":30,
            "type":"string",
            "description":"Pay range of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkMonths":{
            "title":"Work Duration Months",
            "type":"integer",
            "description":"Work months of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExcludedLocationOneId":{
            "title":"First Excluded Location",
            "type":"integer",
            "description":"Excluded location one identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TempAssignFlag":{
            "title":"Consider Temporary Assignment",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether temporary assignment is in the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredLocationTwoId":{
            "title":"Second Preferred Location",
            "type":"integer",
            "description":"Preferred location two identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExcludedLocationThreeId":{
            "title":"Third Excluded Location",
            "type":"integer",
            "description":"Excluded location three identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PreferredLocationFourId":{
            "title":"Fourth Preferred Location",
            "type":"integer",
            "description":"Preferred location four identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MinimumPay":{
            "title":"Minimum Pay",
            "type":"integer",
            "description":"Minimum pay of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PreferredLocationThreeId":{
            "title":"Third Preferred Location",
            "type":"integer",
            "description":"Preferred location three identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments of the candidate work preferences.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "FullTimeEquivalent":{
            "title":"Full Time Equivalent",
            "type":"number",
            "description":"Full time equivalent of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":15,
                "scale":2
            }
        },
        "IntlTravelFrequency":{
            "title":"International Travel Frequency",
            "maxLength":30,
            "type":"string",
            "description":"International travel frequency of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredLocationOneId":{
            "title":"First Preferred Location",
            "type":"integer",
            "description":"Preferred location one identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExcludedLocationFourId":{
            "title":"Fourth Excluded Location",
            "type":"integer",
            "description":"Excluded location four identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartAssignFlag":{
            "title":"Consider Part Time Work",
            "maxLength":30,
            "type":"boolean",
            "description":"Part assign indicator of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "RelocateDuration":{
            "title":"Length of Willing to Relocate",
            "type":"integer",
            "description":"Relocate duration of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WorkYears":{
            "title":"Work Duration Years",
            "type":"integer",
            "description":"Work years of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RelocationReason":{
            "title":"Relocation Reason",
            "maxLength":240,
            "type":"string",
            "description":"Relocation reason of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "IntlTravelFlag":{
            "title":"Travel Internationally",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether international travel is in the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkHours":{
            "title":"Work Hours",
            "maxLength":30,
            "type":"string",
            "description":"Work hours of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "DateFrom":{
            "type":"string",
            "description":"Date from of the candidate work preferences.",
            "format":"date",
            "nullable":false,
            "x-queryable":false
        },
        "IntlTravelRequiredFlag":{
            "title":"International Travel Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether international travel is required in the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "SectionId":{
            "type":"integer",
            "description":"Section identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DateTo":{
            "type":"string",
            "description":"Date to of the candidate work preferences.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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 : recruitingJobSiteCandidates-workPreferences-item-response

Type: object

Show Source

• AllLocationsFlag: boolean
  Title: All Locations

  Maximum Length: 30

  Indicates whether all locations are included in the candidate work preferences.
• Comments: string (byte)
  Title: Comments

  Comments of the candidate work preferences.
• ContentItemId: integer (int64)
  Content item identifier of the candidate work preferences.
• CurrencyCode: string
  Title: Currency Code

  Maximum Length: 30

  Currency code of the candidate work preferences.
• DateFrom: string (date)
  Date from of the candidate work preferences.
• DateTo: string (date)
  Date to of the candidate work preferences.
• ExcludedLocationFourId: integer (int64)
  Title: Fourth Excluded Location

  Excluded location four identifier of the candidate work preferences.
• ExcludedLocationOneId: integer (int64)
  Title: First Excluded Location

  Excluded location one identifier of the candidate work preferences.
• ExcludedLocationThreeId: integer (int64)
  Title: Third Excluded Location

  Excluded location three identifier of the candidate work preferences.
• ExcludedLocationTwoId: integer (int64)
  Title: Second Excluded Location

  Excluded location two identifier of the candidate work preferences.
• FlexibleWorkFlag: boolean
  Title: Work a Flexible Schedule

  Maximum Length: 30

  Indicates whether flexible work is required in the candidate work preferences.
• FullTimeEquivalent: number
  Title: Full Time Equivalent

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

  Maximum Length: 30

  Indicates whether international travel is in the candidate work preferences.
• IntlTravelFrequency: string
  Title: International Travel Frequency

  Maximum Length: 30

  International travel frequency of the candidate work preferences.
• IntlTravelRequiredFlag: boolean
  Title: International Travel Required

  Maximum Length: 30

  Indicates whether international travel is required in the candidate work preferences.
• links: array Links
  Title: Links

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

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

  Maximum Length: 30

  Indicates whether domestic travel is in the candidate work preferences.
• NatTravelFrequency: string
  Title: Domestic Travel Frequency

  Maximum Length: 30

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

  Maximum Length: 30

  Indicates whether domestic travel is required in the candidate work preferences.
• PartAssignFlag: boolean
  Title: Consider Part Time Work

  Maximum Length: 30

  Part assign indicator of the candidate work preferences.
• PayFrequency: string
  Title: Pay Frequency

  Maximum Length: 30

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

  Maximum Length: 30

  Pay range of the candidate work preferences.
• PreferredLocationFourId: integer (int64)
  Title: Fourth Preferred Location

  Preferred location four identifier of the candidate work preferences.
• PreferredLocationOneId: integer (int64)
  Title: First Preferred Location

  Preferred location one identifier of the candidate work preferences.
• PreferredLocationThreeId: integer (int64)
  Title: Third Preferred Location

  Preferred location three identifier of the candidate work preferences.
• PreferredLocationTwoId: integer (int64)
  Title: Second Preferred Location

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

  Relocate duration of the candidate work preferences.
• RelocateFlag: boolean
  Title: Willing to Relocate

  Maximum Length: 30

  Indicates whether relocation is possible in the candidate work preferences.
• RelocationReason: string
  Title: Relocation Reason

  Maximum Length: 240

  Relocation reason of the candidate work preferences.
• SectionId: integer (int64)
  Section identifier of the candidate work preferences.
• TempAssignFlag: boolean
  Title: Consider Temporary Assignment

  Maximum Length: 30

  Indicates whether temporary assignment is in the candidate work preferences.
• WorkDays: string
  Title: Work Days

  Maximum Length: 30

  Work days of the candidate work preferences.
• WorkHours: string
  Title: Work Hours

  Maximum Length: 30

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

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

  Work years of the candidate work preferences.

{
    "type":"object",
    "properties":{
        "NatTravelRequiredFlag":{
            "title":"Travel Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether domestic travel is required in the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "FlexibleWorkFlag":{
            "title":"Work a Flexible Schedule",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether flexible work is required in the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "NatTravelFlag":{
            "title":"Travel Domestically",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether domestic travel is in the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "RelocateFlag":{
            "title":"Willing to Relocate",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether relocation is possible in the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkDays":{
            "title":"Work Days",
            "maxLength":30,
            "type":"string",
            "description":"Work days of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "ExcludedLocationTwoId":{
            "title":"Second Excluded Location",
            "type":"integer",
            "description":"Excluded location two identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "NatTravelFrequency":{
            "title":"Domestic Travel Frequency",
            "maxLength":30,
            "type":"string",
            "description":"National travel frequency of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "AllLocationsFlag":{
            "title":"All Locations",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether all locations are included in the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "CurrencyCode":{
            "title":"Currency Code",
            "maxLength":30,
            "type":"string",
            "description":"Currency code of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "ContentItemId":{
            "type":"integer",
            "description":"Content item identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PayFrequency":{
            "title":"Pay Frequency",
            "maxLength":30,
            "type":"string",
            "description":"Pay frequency of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "PayRange":{
            "title":"Pay Range",
            "maxLength":30,
            "type":"string",
            "description":"Pay range of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkMonths":{
            "title":"Work Duration Months",
            "type":"integer",
            "description":"Work months of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExcludedLocationOneId":{
            "title":"First Excluded Location",
            "type":"integer",
            "description":"Excluded location one identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "TempAssignFlag":{
            "title":"Consider Temporary Assignment",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether temporary assignment is in the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "PreferredLocationTwoId":{
            "title":"Second Preferred Location",
            "type":"integer",
            "description":"Preferred location two identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExcludedLocationThreeId":{
            "title":"Third Excluded Location",
            "type":"integer",
            "description":"Excluded location three identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PreferredLocationFourId":{
            "title":"Fourth Preferred Location",
            "type":"integer",
            "description":"Preferred location four identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "MinimumPay":{
            "title":"Minimum Pay",
            "type":"integer",
            "description":"Minimum pay of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PreferredLocationThreeId":{
            "title":"Third Preferred Location",
            "type":"integer",
            "description":"Preferred location three identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"Comments of the candidate work preferences.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "FullTimeEquivalent":{
            "title":"Full Time Equivalent",
            "type":"number",
            "description":"Full time equivalent of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":15,
                "scale":2
            }
        },
        "IntlTravelFrequency":{
            "title":"International Travel Frequency",
            "maxLength":30,
            "type":"string",
            "description":"International travel frequency of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkPreferenceId":{
            "type":"integer",
            "description":"Work preference identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PreferredLocationOneId":{
            "title":"First Preferred Location",
            "type":"integer",
            "description":"Preferred location one identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ExcludedLocationFourId":{
            "title":"Fourth Excluded Location",
            "type":"integer",
            "description":"Excluded location four identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartAssignFlag":{
            "title":"Consider Part Time Work",
            "maxLength":30,
            "type":"boolean",
            "description":"Part assign indicator of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "RelocateDuration":{
            "title":"Length of Willing to Relocate",
            "type":"integer",
            "description":"Relocate duration of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "WorkYears":{
            "title":"Work Duration Years",
            "type":"integer",
            "description":"Work years of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "RelocationReason":{
            "title":"Relocation Reason",
            "maxLength":240,
            "type":"string",
            "description":"Relocation reason of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "IntlTravelFlag":{
            "title":"Travel Internationally",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether international travel is in the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "WorkHours":{
            "title":"Work Hours",
            "maxLength":30,
            "type":"string",
            "description":"Work hours of the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "DateFrom":{
            "type":"string",
            "description":"Date from of the candidate work preferences.",
            "format":"date",
            "nullable":false,
            "x-queryable":false
        },
        "IntlTravelRequiredFlag":{
            "title":"International Travel Required",
            "maxLength":30,
            "type":"boolean",
            "description":"Indicates whether international travel is required in the candidate work preferences.",
            "nullable":true,
            "x-queryable":false
        },
        "SectionId":{
            "type":"integer",
            "description":"Section identifier of the candidate work preferences.",
            "format":"int64",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "precision":18
            }
        },
        "DateTo":{
            "type":"string",
            "description":"Date to of the candidate work preferences.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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