Jump to

• Request
• Response

Update a recruiting job alert preference

patch

/hcmRestApi/resources/11.13.18.05/recruitingJobAlertPreferences/{PreferenceId}

Request

Path Parameters

• PreferenceId(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

• AugmentationStatus: string
  Maximum Length: 30

  Status of the text augmentation for the job alert preference.
• AugmentedText: string (byte)
  Augmented text generated for the job alert preference.
• AugmentedTextString: string
  String representation of the augmented text for the job alert preference.
• AugmentedVector: string (byte)
  Vector generated from the augmented text for the job alert preference.
• AugmentedVectorString: string
  String representation of the augmented vector for the job alert preference.
• Filter: string (byte)
  Search filter criteria for the recruiting job alert preference.
• GeoLocation: string (byte)
  Geographic location used for the recruiting job alert preference.
• ObjectVersionNumber: integer (int32)
  Number that identifies the version of the recruiting job alert preference row.
• PersonId: integer (int64)
  Unique identifier of the person associated with the recruiting job alert preference.
• ResumeAttachmentId: integer (int64)
  Unique identifier for the resume attachment associated with the job alert preference.
• SearchText: string
  Maximum Length: 4000

  Search text used to match jobs for the job alert preference.
• SiteNumber: string
  Maximum Length: 250

  Number that identifies the career site for the job alert preference.

{
    "type":"object",
    "properties":{
        "AugmentationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the text augmentation for the job alert preference.",
            "nullable":true
        },
        "AugmentedText":{
            "type":"string",
            "description":"Augmented text generated for the job alert preference.",
            "format":"byte",
            "nullable":true
        },
        "AugmentedTextString":{
            "type":"string",
            "description":"String representation of the augmented text for the job alert preference.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AugmentedText"
                ]
            }
        },
        "AugmentedVector":{
            "type":"string",
            "description":"Vector generated from the augmented text for the job alert preference.",
            "format":"byte",
            "nullable":true
        },
        "AugmentedVectorString":{
            "type":"string",
            "description":"String representation of the augmented vector for the job alert preference.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AugmentedVector"
                ]
            }
        },
        "Filter":{
            "type":"string",
            "description":"Search filter criteria for the recruiting job alert preference.",
            "format":"byte",
            "nullable":true
        },
        "GeoLocation":{
            "type":"string",
            "description":"Geographic location used for the recruiting job alert preference.",
            "format":"byte",
            "nullable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the version of the recruiting job alert preference row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier of the person associated with the recruiting job alert preference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "ResumeAttachmentId":{
            "type":"integer",
            "description":"Unique identifier for the resume attachment associated with the job alert preference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "SearchText":{
            "maxLength":4000,
            "type":"string",
            "description":"Search text used to match jobs for the job alert preference.",
            "nullable":true
        },
        "SiteNumber":{
            "maxLength":250,
            "type":"string",
            "description":"Number that identifies the career site for the job alert preference.",
            "nullable":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 : recruitingJobAlertPreferences-item-response

Type: object

Show Source

• AugmentationStatus: string
  Maximum Length: 30

  Status of the text augmentation for the job alert preference.
• AugmentedText: string (byte)
  Augmented text generated for the job alert preference.
• AugmentedTextString: string
  String representation of the augmented text for the job alert preference.
• AugmentedVector: string (byte)
  Vector generated from the augmented text for the job alert preference.
• AugmentedVectorString: string
  String representation of the augmented vector for the job alert preference.
• CandidatePreferredLanguage: string
  Read Only: true

  Maximum Length: 255

  Preferred language of the candidate for job alert communications.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the job alert preference.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the recruiting job alert preference was created.
• Filter: string (byte)
  Search filter criteria for the recruiting job alert preference.
• GeoLocation: string (byte)
  Geographic location used for the recruiting job alert preference.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the recruiting job alert preference was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the recruiting job alert preference.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Session login associated with the last update to the recruiting job alert preference.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectVersionNumber: integer (int32)
  Number that identifies the version of the recruiting job alert preference row.
• PersonId: integer (int64)
  Unique identifier of the person associated with the recruiting job alert preference.
• PreferenceId: integer (int64)
  Unique identifier for the job alert preference.
• ResumeAttachmentId: integer (int64)
  Unique identifier for the resume attachment associated with the job alert preference.
• ResumeText: string
  Read Only: true

  Maximum Length: 4000

  Text extracted from the resume associated with the job alert preference.
• SearchText: string
  Maximum Length: 4000

  Search text used to match jobs for the job alert preference.
• SiteNumber: string
  Maximum Length: 250

  Number that identifies the career site for the job alert preference.

{
    "type":"object",
    "properties":{
        "AugmentationStatus":{
            "maxLength":30,
            "type":"string",
            "description":"Status of the text augmentation for the job alert preference.",
            "nullable":true,
            "x-queryable":true
        },
        "AugmentedText":{
            "type":"string",
            "description":"Augmented text generated for the job alert preference.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "AugmentedTextString":{
            "type":"string",
            "description":"String representation of the augmented text for the job alert preference.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AugmentedText"
                ]
            },
            "x-queryable":true
        },
        "AugmentedVector":{
            "type":"string",
            "description":"Vector generated from the augmented text for the job alert preference.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "AugmentedVectorString":{
            "type":"string",
            "description":"String representation of the augmented vector for the job alert preference.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "AugmentedVector"
                ]
            },
            "x-queryable":true
        },
        "CandidatePreferredLanguage":{
            "maxLength":255,
            "type":"string",
            "description":"Preferred language of the candidate for job alert communications.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the job alert preference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the recruiting job alert preference was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Filter":{
            "type":"string",
            "description":"Search filter criteria for the recruiting job alert preference.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "GeoLocation":{
            "type":"string",
            "description":"Geographic location used for the recruiting job alert preference.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the recruiting job alert preference was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Session login associated with the last update to the recruiting job alert preference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the recruiting job alert preference.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Number that identifies the version of the recruiting job alert preference row.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Unique identifier of the person associated with the recruiting job alert preference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PreferenceId":{
            "type":"integer",
            "description":"Unique identifier for the job alert preference.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResumeAttachmentId":{
            "type":"integer",
            "description":"Unique identifier for the resume attachment associated with the job alert preference.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ResumeText":{
            "maxLength":4000,
            "type":"string",
            "description":"Text extracted from the resume associated with the job alert preference.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SearchText":{
            "maxLength":4000,
            "type":"string",
            "description":"Search text used to match jobs for the job alert preference.",
            "nullable":true,
            "x-queryable":true
        },
        "SiteNumber":{
            "maxLength":250,
            "type":"string",
            "description":"Number that identifies the career site for the job alert preference.",
            "nullable":false,
            "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