Jump to

• Request
• Response

Update a recruiting agent in the job requisition

patch

/hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAgents/{RequisitionId}

Request

Path Parameters

• RequisitionId(required): integer
  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

• Action: string
  Maximum Length: 255

  Action.
• AgencyId: integer
  Agency ID.
• AgencyName: string
  Maximum Length: 255

  Agency name.
• AgentId: integer
  Agent ID.
• agentJobFamilies: array Agent Job Family on Job Requisition
  Title: Agent Job Family on Job Requisition

  The AgentJobFamilyV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the job family of the recruiting agent.
• agentLocations: array Agent Location on Job Requisition
  Title: Agent Location on Job Requisition

  The AgentLocationV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the location of the recruiting agent.
• AgentName: string
  Maximum Length: 255

  Agent name.
• ExpirationDate: string (date-time)
  Title: Invitation Expiration

  Expiration date.
• ExpirationStatus: string
  Maximum Length: 255

  Expiration status.
• GeographyName: string
  Maximum Length: 255

  Geography name.
• IsInvited: string
  Title: Invitation Status

  Maximum Length: 255

  Invited agent.
• JobFamilyName: string
  Title: Job Family

  Maximum Length: 255

  Job family name.
• PublishEndDate: string (date-time)
  Publication end date.
• RequisitionId: integer
  Requisition ID.
• SuccessfulSubmissionPercent: number
  Title: Successful Applications

  Successful submission percentage.
• TimeZone: string
  Title: Time Zone

  Maximum Length: 255

  Time zone.

{
    "type":"object",
    "properties":{
        "AgencyName":{
            "maxLength":"255",
            "type":"string",
            "description":"Agency name.",
            "nullable":true
        },
        "agentLocations":{
            "title":"Agent Location on Job Requisition",
            "type":"array",
            "description":"The AgentLocationV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the location of the recruiting agent.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIRequisitionAgents-agentLocations-item-patch-request"
            }
        },
        "Action":{
            "maxLength":"255",
            "type":"string",
            "description":"Action.",
            "nullable":false
        },
        "AgencyId":{
            "type":"integer",
            "description":"Agency ID.",
            "nullable":true
        },
        "IsInvited":{
            "title":"Invitation Status",
            "maxLength":"255",
            "type":"string",
            "description":"Invited agent.",
            "nullable":true
        },
        "GeographyName":{
            "maxLength":"255",
            "type":"string",
            "description":"Geography name.",
            "nullable":true
        },
        "ExpirationStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Expiration status.",
            "nullable":true
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Requisition ID.",
            "nullable":true
        },
        "JobFamilyName":{
            "title":"Job Family",
            "maxLength":"255",
            "type":"string",
            "description":"Job family name.",
            "nullable":true
        },
        "TimeZone":{
            "title":"Time Zone",
            "maxLength":"255",
            "type":"string",
            "description":"Time zone.",
            "nullable":true
        },
        "agentJobFamilies":{
            "title":"Agent Job Family on Job Requisition",
            "type":"array",
            "description":"The AgentJobFamilyV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the job family of the recruiting agent.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIRequisitionAgents-agentJobFamilies-item-patch-request"
            }
        },
        "PublishEndDate":{
            "type":"string",
            "description":"Publication end date.",
            "format":"date-time",
            "nullable":true
        },
        "ExpirationDate":{
            "title":"Invitation Expiration",
            "type":"string",
            "description":"Expiration date.",
            "format":"date-time",
            "nullable":true
        },
        "AgentId":{
            "type":"integer",
            "description":"Agent ID.",
            "nullable":true
        },
        "AgentName":{
            "maxLength":"255",
            "type":"string",
            "description":"Agent name.",
            "nullable":true
        },
        "SuccessfulSubmissionPercent":{
            "title":"Successful Applications",
            "type":"number",
            "description":"Successful submission percentage.",
            "nullable":true
        }
    }
}

Nested Schema : Agent Job Family on Job Requisition

Type: array

Title: Agent Job Family on Job Requisition

The AgentJobFamilyV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the job family of the recruiting agent.

Show Source

• Array of: object recruitingUIRequisitionAgents-agentJobFamilies-item-patch-request

{
    "title":"Agent Job Family on Job Requisition",
    "type":"array",
    "description":"The AgentJobFamilyV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the job family of the recruiting agent.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIRequisitionAgents-agentJobFamilies-item-patch-request"
    }
}

Nested Schema : Agent Location on Job Requisition

Type: array

Title: Agent Location on Job Requisition

The AgentLocationV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the location of the recruiting agent.

Show Source

• Array of: object recruitingUIRequisitionAgents-agentLocations-item-patch-request

{
    "title":"Agent Location on Job Requisition",
    "type":"array",
    "description":"The AgentLocationV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the location of the recruiting agent.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIRequisitionAgents-agentLocations-item-patch-request"
    }
}

Nested Schema : recruitingUIRequisitionAgents-agentJobFamilies-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

Nested Schema : recruitingUIRequisitionAgents-agentLocations-item-patch-request

Type: object

Show Source

{
    "type":"object",
    "properties":{
    }
}

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 : recruitingUIRequisitionAgents-item-response

Type: object

Show Source

• Action: string
  Maximum Length: 255

  Action.
• AgencyId: integer
  Agency ID.
• AgencyName: string
  Maximum Length: 255

  Agency name.
• AgentId: integer
  Agent ID.
• agentJobFamilies: array Agent Job Family on Job Requisition
  Title: Agent Job Family on Job Requisition

  The AgentJobFamilyV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the job family of the recruiting agent.
• agentLocations: array Agent Location on Job Requisition
  Title: Agent Location on Job Requisition

  The AgentLocationV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the location of the recruiting agent.
• AgentName: string
  Maximum Length: 255

  Agent name.
• ExpirationDate: string (date-time)
  Title: Invitation Expiration

  Expiration date.
• ExpirationStatus: string
  Maximum Length: 255

  Expiration status.
• GeographyName: string
  Maximum Length: 255

  Geography name.
• IsInvited: string
  Title: Invitation Status

  Maximum Length: 255

  Invited agent.
• JobFamilyName: string
  Title: Job Family

  Maximum Length: 255

  Job family name.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PublishEndDate: string (date-time)
  Publication end date.
• RequisitionId: integer
  Requisition ID.
• SuccessfulSubmissionPercent: number
  Title: Successful Applications

  Successful submission percentage.
• TimeZone: string
  Title: Time Zone

  Maximum Length: 255

  Time zone.

{
    "type":"object",
    "properties":{
        "AgencyName":{
            "maxLength":"255",
            "type":"string",
            "description":"Agency name.",
            "nullable":true,
            "x-queryable":true
        },
        "agentLocations":{
            "title":"Agent Location on Job Requisition",
            "type":"array",
            "description":"The AgentLocationV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the location of the recruiting agent.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIRequisitionAgents-agentLocations-item-response"
            }
        },
        "Action":{
            "maxLength":"255",
            "type":"string",
            "description":"Action.",
            "nullable":false,
            "x-queryable":true
        },
        "AgencyId":{
            "type":"integer",
            "description":"Agency ID.",
            "nullable":true,
            "x-queryable":true
        },
        "IsInvited":{
            "title":"Invitation Status",
            "maxLength":"255",
            "type":"string",
            "description":"Invited agent.",
            "nullable":true,
            "x-queryable":true
        },
        "GeographyName":{
            "maxLength":"255",
            "type":"string",
            "description":"Geography name.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationStatus":{
            "maxLength":"255",
            "type":"string",
            "description":"Expiration status.",
            "nullable":true,
            "x-queryable":true
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Requisition ID.",
            "nullable":true,
            "x-queryable":true
        },
        "JobFamilyName":{
            "title":"Job Family",
            "maxLength":"255",
            "type":"string",
            "description":"Job family name.",
            "nullable":true,
            "x-queryable":true
        },
        "TimeZone":{
            "title":"Time Zone",
            "maxLength":"255",
            "type":"string",
            "description":"Time zone.",
            "nullable":true,
            "x-queryable":true
        },
        "agentJobFamilies":{
            "title":"Agent Job Family on Job Requisition",
            "type":"array",
            "description":"The AgentJobFamilyV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the job family of the recruiting agent.",
            "items":{
                "$ref":"#/components/schemas/recruitingUIRequisitionAgents-agentJobFamilies-item-response"
            }
        },
        "PublishEndDate":{
            "type":"string",
            "description":"Publication end date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ExpirationDate":{
            "title":"Invitation Expiration",
            "type":"string",
            "description":"Expiration date.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AgentId":{
            "type":"integer",
            "description":"Agent ID.",
            "nullable":true,
            "x-queryable":true
        },
        "AgentName":{
            "maxLength":"255",
            "type":"string",
            "description":"Agent name.",
            "nullable":true,
            "x-queryable":true
        },
        "SuccessfulSubmissionPercent":{
            "title":"Successful Applications",
            "type":"number",
            "description":"Successful submission percentage.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Agent Job Family on Job Requisition

Type: array

Title: Agent Job Family on Job Requisition

The AgentJobFamilyV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the job family of the recruiting agent.

Show Source

• Array of: object recruitingUIRequisitionAgents-agentJobFamilies-item-response

{
    "title":"Agent Job Family on Job Requisition",
    "type":"array",
    "description":"The AgentJobFamilyV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the job family of the recruiting agent.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIRequisitionAgents-agentJobFamilies-item-response"
    }
}

Nested Schema : Agent Location on Job Requisition

Type: array

Title: Agent Location on Job Requisition

The AgentLocationV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the location of the recruiting agent.

Show Source

• Array of: object recruitingUIRequisitionAgents-agentLocations-item-response

{
    "title":"Agent Location on Job Requisition",
    "type":"array",
    "description":"The AgentLocationV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the location of the recruiting agent.",
    "items":{
        "$ref":"#/components/schemas/recruitingUIRequisitionAgents-agentLocations-item-response"
    }
}

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 : recruitingUIRequisitionAgents-agentJobFamilies-item-response

Type: object

Show Source

• JobFamilyId: integer (int64)
  Read Only: true

  Job family ID.
• JobFamilyName: string
  Read Only: true

  Maximum Length: 240

  Job family name.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectCxtId: integer
  Read Only: true

  Object context ID.
• ObjectCxtJobFamId: integer (int64)
  Read Only: true

  Object context job family ID.
• ObjectId: integer (int64)
  Read Only: true

  Object ID of the agent's job family.
• ObjectTypeCode: string
  Read Only: true

  Maximum Length: 30

  Object type code of the agent's job family.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Object version number of the agent's job family.
• ObjectVersionNumberFamily: integer (int32)
  Read Only: true

  Object version number family of the agent's job family.

{
    "type":"object",
    "properties":{
        "JobFamilyName":{
            "maxLength":"240",
            "type":"string",
            "description":"Job family name.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "JobFamilyId":{
            "type":"integer",
            "description":"Job family ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Object ID of the agent's job family.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number of the agent's job family.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ObjectTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Object type code of the agent's job family.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectCxtId":{
            "type":"integer",
            "description":"Object context ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectVersionNumberFamily":{
            "type":"integer",
            "description":"Object version number family of the agent's job family.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ObjectCxtJobFamId":{
            "type":"integer",
            "description":"Object context job family ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        }
    }
}

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."
        }
    }
}

Nested Schema : recruitingUIRequisitionAgents-agentLocations-item-response

Type: object

Show Source

• GeographyId: integer (int64)
  Read Only: true

  Geography ID.
• GeographyName: string
  Read Only: true

  Maximum Length: 255

  Geography name of the agent's location.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ObjectCxtId: integer
  Read Only: true

  Object context ID of the agent's location.
• ObjectCxtLocId: integer (int64)
  Read Only: true

  Object context location ID.
• ObjectId: integer (int64)
  Read Only: true

  Object ID of the agent's location.
• ObjectTypeCode: string
  Read Only: true

  Maximum Length: 30

  Object type code of the agent's location.
• ObjectVersionNumber: integer (int32)
  Read Only: true

  Object version number of the agent's location.
• ObjectVersionNumberLocation: integer (int32)
  Read Only: true

  Object version number family of the agent's location.

{
    "type":"object",
    "properties":{
        "ObjectCxtLocId":{
            "type":"integer",
            "description":"Object context location ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "GeographyId":{
            "type":"integer",
            "description":"Geography ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumberLocation":{
            "type":"integer",
            "description":"Object version number family of the agent's location.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"Object ID of the agent's location.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"Object version number of the agent's location.",
            "format":"int32",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"9"
            },
            "x-queryable":true
        },
        "ObjectTypeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Object type code of the agent's location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "GeographyName":{
            "maxLength":"255",
            "type":"string",
            "description":"Geography name of the agent's location.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "dependencies":[
                    "GeographyId"
                ]
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ObjectCxtId":{
            "type":"integer",
            "description":"Object context ID of the agent's location.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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"
    }
}

Links

agentJobFamilies

Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAgents/{RequisitionId}/child/agentJobFamilies

Parameters:

• RequisitionId: $request.path.RequisitionId

The AgentJobFamilyV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the job family of the recruiting agent.

agentLocations

Operation: /hcmRestApi/resources/11.13.18.05/recruitingUIRequisitionAgents/{RequisitionId}/child/agentLocations

Parameters:

• RequisitionId: $request.path.RequisitionId

The AgentLocationV2 resource is a child of the recruitingUIRequisitionAgents resource and provides details about the location of the recruiting agent.

Back to Top