Jump to

• Request
• Response

Update a source

patch

/hcmRestApi/resources/11.13.18.05/recruitingUISourceTrackings/{SourceTrackingId}

Request

Path Parameters

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

• AgencyName: string
  Title: Agency Name

  Maximum Length: 255

  Agency name.
• AgentFirstName: string
  Maximum Length: 300

  Agent first name.
• AgentLastName: string
  Title: Agent

  Maximum Length: 255

  Agent last name.
• AssetName: string
  Title: Post

  Maximum Length: 255

  Asset name.
• CampaignCode: string
  Title: Campaign

  Maximum Length: 255

  Campaign code.
• CampaignName: string
  Title: Campaign

  Maximum Length: 255

  Campaign name.
• CampaignPostId: integer
  Title: Post

  Campaign post identifier.
• CandidateNumber: string
  Candidate number.
• Context: string
  Maximum Length: 255

  Context.
• CustomSourceName: string
  Title: Add or Create a Source

  Maximum Length: 255

  Custom source name.
• DimensionId: integer
  Dimension identifier.
• EventId: integer
  Event identifier.
• EventName: string
  Title: Event

  Maximum Length: 255

  Event name.
• FromEventId: integer
  Title: Event

  From event identifier.
• FromPoolId: integer
  Title: Candidate Pool

  From pool identifier.
• FromRequisitionId: integer
  Title: Job Requisition

  From requisition identifier.
• IsExtensibleSource: string
  Maximum Length: 255

  Extensible source indicator.
• IsRecordEditable: string
  Maximum Length: 255

  Editable record indicator.
• OrigSourceMedium: string
  Maximum Length: 255

  Original source medium.
• OrigSourceName: string
  Maximum Length: 255

  Original source name.
• PersonId: integer
  Person identifier
• PoolId: integer
  Pool identifier.
• PoolMemberId: integer
  Pool member identifier.
• PoolName: string
  Title: Candidate Pool

  Maximum Length: 255

  Pool name.
• ProspectId: integer
  Prospect identifier.
• RecruiterId: integer
  Title: Added By

  Recruiter identifier.
• RecruiterName: string
  Title: Created By

  Maximum Length: 255

  Recruiter name.
• ReferrerId: integer
  Referrer identifier.
• ReferrerName: string
  Title: Referred By

  Maximum Length: 255

  Referrer name.
• RequisitionId: integer
  Requisition identifier.
• RequisitionTitle: string
  Title: Job Requisition

  Maximum Length: 255

  Requisition title.
• SharerId: integer
  Sharer identifier.
• SharerName: string
  Title: Referred By

  Maximum Length: 255

  Sharer name.
• SiteCode: string
  Title: Career Site

  Maximum Length: 255

  Site code.
• SiteName: string
  Title: Career Site

  Maximum Length: 255

  Site name.
• SiteNumber: string
  Title: Career Site

  Maximum Length: 255

  Site number.
• SourceDisplayName: string
  Title: Source

  Maximum Length: 255

  Source display name.
• SourceMedium: string
  Title: Source Medium

  Maximum Length: 255

  Source medium.
• SourceMediumURLValue: string
  Maximum Length: 255

  Source medium URL value.
• SourceName: string
  Title: Source

  Maximum Length: 255

  Source name.
• SourceTrackingId: integer
  Source tracking identifier.
• SourceURLValue: string
  Maximum Length: 255

  Source URL value.
• SubmissionId: integer
  Submission identifier.

{
    "type":"object",
    "properties":{
        "SharerName":{
            "title":"Referred By",
            "maxLength":255,
            "type":"string",
            "description":"Sharer name.",
            "nullable":true
        },
        "SiteName":{
            "title":"Career Site",
            "maxLength":255,
            "type":"string",
            "description":"Site name.",
            "nullable":true
        },
        "SourceDisplayName":{
            "title":"Source",
            "maxLength":255,
            "type":"string",
            "description":"Source display name.",
            "nullable":true
        },
        "SourceMedium":{
            "title":"Source Medium",
            "maxLength":255,
            "type":"string",
            "description":"Source medium.",
            "nullable":true
        },
        "CampaignName":{
            "title":"Campaign",
            "maxLength":255,
            "type":"string",
            "description":"Campaign name.",
            "nullable":true
        },
        "SharerId":{
            "type":"integer",
            "description":"Sharer identifier.",
            "nullable":true
        },
        "FromRequisitionId":{
            "title":"Job Requisition",
            "type":"integer",
            "description":"From requisition identifier.",
            "nullable":true
        },
        "FromPoolId":{
            "title":"Candidate Pool",
            "type":"integer",
            "description":"From pool identifier.",
            "nullable":true
        },
        "CampaignPostId":{
            "title":"Post",
            "type":"integer",
            "description":"Campaign post identifier.",
            "nullable":true
        },
        "IsExtensibleSource":{
            "maxLength":255,
            "type":"string",
            "description":"Extensible source indicator.",
            "nullable":true
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Requisition identifier.",
            "nullable":true
        },
        "PoolName":{
            "title":"Candidate Pool",
            "maxLength":255,
            "type":"string",
            "description":"Pool name.",
            "nullable":true
        },
        "EventId":{
            "type":"integer",
            "description":"Event identifier.",
            "nullable":true
        },
        "RecruiterName":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"Recruiter name.",
            "nullable":true
        },
        "CustomSourceName":{
            "title":"Add or Create a Source",
            "maxLength":255,
            "type":"string",
            "description":"Custom source name.",
            "nullable":true
        },
        "SourceTrackingId":{
            "type":"integer",
            "description":"Source tracking identifier.",
            "nullable":true
        },
        "FromEventId":{
            "title":"Event",
            "type":"integer",
            "description":"From event identifier.",
            "nullable":true
        },
        "SourceURLValue":{
            "maxLength":255,
            "type":"string",
            "description":"Source URL value.",
            "nullable":true
        },
        "ReferrerName":{
            "title":"Referred By",
            "maxLength":255,
            "type":"string",
            "description":"Referrer name.",
            "nullable":true
        },
        "AgencyName":{
            "title":"Agency Name",
            "maxLength":255,
            "type":"string",
            "description":"Agency name.",
            "nullable":true
        },
        "Context":{
            "maxLength":255,
            "type":"string",
            "description":"Context.",
            "nullable":true
        },
        "CandidateNumber":{
            "type":"string",
            "description":"Candidate number.",
            "nullable":true
        },
        "AgentLastName":{
            "title":"Agent",
            "maxLength":255,
            "type":"string",
            "description":"Agent last name.",
            "nullable":true
        },
        "PoolId":{
            "type":"integer",
            "description":"Pool identifier.",
            "nullable":true
        },
        "SiteCode":{
            "title":"Career Site",
            "maxLength":255,
            "type":"string",
            "description":"Site code.",
            "nullable":true
        },
        "SourceName":{
            "title":"Source",
            "maxLength":255,
            "type":"string",
            "description":"Source name.",
            "nullable":true
        },
        "RecruiterId":{
            "title":"Added By",
            "type":"integer",
            "description":"Recruiter identifier.",
            "nullable":true
        },
        "ReferrerId":{
            "type":"integer",
            "description":"Referrer identifier.",
            "nullable":true
        },
        "EventName":{
            "title":"Event",
            "maxLength":255,
            "type":"string",
            "description":"Event name.",
            "nullable":true
        },
        "SiteNumber":{
            "title":"Career Site",
            "maxLength":255,
            "type":"string",
            "description":"Site number.",
            "nullable":true
        },
        "AssetName":{
            "title":"Post",
            "maxLength":255,
            "type":"string",
            "description":"Asset name.",
            "nullable":true
        },
        "CampaignCode":{
            "title":"Campaign",
            "maxLength":255,
            "type":"string",
            "description":"Campaign code.",
            "nullable":true
        },
        "OrigSourceMedium":{
            "maxLength":255,
            "type":"string",
            "description":"Original source medium.",
            "nullable":true
        },
        "AgentFirstName":{
            "maxLength":300,
            "type":"string",
            "description":"Agent first name.",
            "nullable":true
        },
        "IsRecordEditable":{
            "maxLength":255,
            "type":"string",
            "description":"Editable record indicator.",
            "nullable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier",
            "nullable":true
        },
        "SubmissionId":{
            "type":"integer",
            "description":"Submission identifier.",
            "nullable":true
        },
        "PoolMemberId":{
            "type":"integer",
            "description":"Pool member identifier.",
            "nullable":true
        },
        "OrigSourceName":{
            "maxLength":255,
            "type":"string",
            "description":"Original source name.",
            "nullable":true
        },
        "DimensionId":{
            "type":"integer",
            "description":"Dimension identifier.",
            "nullable":true
        },
        "RequisitionTitle":{
            "title":"Job Requisition",
            "maxLength":255,
            "type":"string",
            "description":"Requisition title.",
            "nullable":true
        },
        "SourceMediumURLValue":{
            "maxLength":255,
            "type":"string",
            "description":"Source medium URL value.",
            "nullable":true
        },
        "ProspectId":{
            "type":"integer",
            "description":"Prospect identifier.",
            "nullable":true
        }
    }
}

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

Type: object

Show Source

• AgencyName: string
  Title: Agency Name

  Maximum Length: 255

  Agency name.
• AgentFirstName: string
  Maximum Length: 300

  Agent first name.
• AgentLastName: string
  Title: Agent

  Maximum Length: 255

  Agent last name.
• AssetName: string
  Title: Post

  Maximum Length: 255

  Asset name.
• CampaignCode: string
  Title: Campaign

  Maximum Length: 255

  Campaign code.
• CampaignName: string
  Title: Campaign

  Maximum Length: 255

  Campaign name.
• CampaignPostId: integer
  Title: Post

  Campaign post identifier.
• CandidateNumber: string
  Candidate number.
• Context: string
  Maximum Length: 255

  Context.
• ContextId: integer
  Read Only: true

  Context identifier.
• CustomSourceName: string
  Title: Add or Create a Source

  Maximum Length: 255

  Custom source name.
• DimensionId: integer
  Dimension identifier.
• EventId: integer
  Event identifier.
• EventName: string
  Title: Event

  Maximum Length: 255

  Event name.
• FromEventId: integer
  Title: Event

  From event identifier.
• FromPoolId: integer
  Title: Candidate Pool

  From pool identifier.
• FromRequisitionId: integer
  Title: Job Requisition

  From requisition identifier.
• IsExtensibleSource: string
  Maximum Length: 255

  Extensible source indicator.
• IsRecordEditable: string
  Maximum Length: 255

  Editable record indicator.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrigSourceMedium: string
  Maximum Length: 255

  Original source medium.
• OrigSourceName: string
  Maximum Length: 255

  Original source name.
• PersonId: integer
  Person identifier
• PoolId: integer
  Pool identifier.
• PoolMemberId: integer
  Pool member identifier.
• PoolName: string
  Title: Candidate Pool

  Maximum Length: 255

  Pool name.
• ProspectId: integer
  Prospect identifier.
• RecruiterId: integer
  Title: Added By

  Recruiter identifier.
• RecruiterName: string
  Title: Created By

  Maximum Length: 255

  Recruiter name.
• ReferrerId: integer
  Referrer identifier.
• ReferrerName: string
  Title: Referred By

  Maximum Length: 255

  Referrer name.
• RequisitionId: integer
  Requisition identifier.
• RequisitionTitle: string
  Title: Job Requisition

  Maximum Length: 255

  Requisition title.
• SharerId: integer
  Sharer identifier.
• SharerName: string
  Title: Referred By

  Maximum Length: 255

  Sharer name.
• SiteCode: string
  Title: Career Site

  Maximum Length: 255

  Site code.
• SiteName: string
  Title: Career Site

  Maximum Length: 255

  Site name.
• SiteNumber: string
  Title: Career Site

  Maximum Length: 255

  Site number.
• SourceDisplayName: string
  Title: Source

  Maximum Length: 255

  Source display name.
• SourceLevel: string
  Read Only: true

  Maximum Length: 255

  Source level.
• SourceMedium: string
  Title: Source Medium

  Maximum Length: 255

  Source medium.
• SourceMediumDisplayValue: string
  Title: Source Medium

  Read Only: true

  Maximum Length: 255

  Source medium display value.
• SourceMediumURLValue: string
  Maximum Length: 255

  Source medium URL value.
• SourceName: string
  Title: Source

  Maximum Length: 255

  Source name.
• SourceTrackingId: integer
  Source tracking identifier.
• SourceURLValue: string
  Maximum Length: 255

  Source URL value.
• SubmissionId: integer
  Submission identifier.

{
    "type":"object",
    "properties":{
        "SourceLevel":{
            "maxLength":255,
            "type":"string",
            "description":"Source level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SharerName":{
            "title":"Referred By",
            "maxLength":255,
            "type":"string",
            "description":"Sharer name.",
            "nullable":true,
            "x-queryable":true
        },
        "SiteName":{
            "title":"Career Site",
            "maxLength":255,
            "type":"string",
            "description":"Site name.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceDisplayName":{
            "title":"Source",
            "maxLength":255,
            "type":"string",
            "description":"Source display name.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceMedium":{
            "title":"Source Medium",
            "maxLength":255,
            "type":"string",
            "description":"Source medium.",
            "nullable":true,
            "x-queryable":true
        },
        "CampaignName":{
            "title":"Campaign",
            "maxLength":255,
            "type":"string",
            "description":"Campaign name.",
            "nullable":true,
            "x-queryable":true
        },
        "SharerId":{
            "type":"integer",
            "description":"Sharer identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "FromRequisitionId":{
            "title":"Job Requisition",
            "type":"integer",
            "description":"From requisition identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "FromPoolId":{
            "title":"Candidate Pool",
            "type":"integer",
            "description":"From pool identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "CampaignPostId":{
            "title":"Post",
            "type":"integer",
            "description":"Campaign post identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "IsExtensibleSource":{
            "maxLength":255,
            "type":"string",
            "description":"Extensible source indicator.",
            "nullable":true,
            "x-queryable":true
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Requisition identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "PoolName":{
            "title":"Candidate Pool",
            "maxLength":255,
            "type":"string",
            "description":"Pool name.",
            "nullable":true,
            "x-queryable":true
        },
        "EventId":{
            "type":"integer",
            "description":"Event identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RecruiterName":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"Recruiter name.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomSourceName":{
            "title":"Add or Create a Source",
            "maxLength":255,
            "type":"string",
            "description":"Custom source name.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceTrackingId":{
            "type":"integer",
            "description":"Source tracking identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "FromEventId":{
            "title":"Event",
            "type":"integer",
            "description":"From event identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceURLValue":{
            "maxLength":255,
            "type":"string",
            "description":"Source URL value.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferrerName":{
            "title":"Referred By",
            "maxLength":255,
            "type":"string",
            "description":"Referrer name.",
            "nullable":true,
            "x-queryable":true
        },
        "AgencyName":{
            "title":"Agency Name",
            "maxLength":255,
            "type":"string",
            "description":"Agency name.",
            "nullable":true,
            "x-queryable":true
        },
        "Context":{
            "maxLength":255,
            "type":"string",
            "description":"Context.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceMediumDisplayValue":{
            "title":"Source Medium",
            "maxLength":255,
            "type":"string",
            "description":"Source medium display value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CandidateNumber":{
            "type":"string",
            "description":"Candidate number.",
            "nullable":true,
            "x-queryable":true
        },
        "AgentLastName":{
            "title":"Agent",
            "maxLength":255,
            "type":"string",
            "description":"Agent last name.",
            "nullable":true,
            "x-queryable":true
        },
        "PoolId":{
            "type":"integer",
            "description":"Pool identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "SiteCode":{
            "title":"Career Site",
            "maxLength":255,
            "type":"string",
            "description":"Site code.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceName":{
            "title":"Source",
            "maxLength":255,
            "type":"string",
            "description":"Source name.",
            "nullable":true,
            "x-queryable":true
        },
        "RecruiterId":{
            "title":"Added By",
            "type":"integer",
            "description":"Recruiter identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "ReferrerId":{
            "type":"integer",
            "description":"Referrer identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "EventName":{
            "title":"Event",
            "maxLength":255,
            "type":"string",
            "description":"Event name.",
            "nullable":true,
            "x-queryable":true
        },
        "SiteNumber":{
            "title":"Career Site",
            "maxLength":255,
            "type":"string",
            "description":"Site number.",
            "nullable":true,
            "x-queryable":true
        },
        "AssetName":{
            "title":"Post",
            "maxLength":255,
            "type":"string",
            "description":"Asset name.",
            "nullable":true,
            "x-queryable":true
        },
        "CampaignCode":{
            "title":"Campaign",
            "maxLength":255,
            "type":"string",
            "description":"Campaign code.",
            "nullable":true,
            "x-queryable":true
        },
        "OrigSourceMedium":{
            "maxLength":255,
            "type":"string",
            "description":"Original source medium.",
            "nullable":true,
            "x-queryable":true
        },
        "AgentFirstName":{
            "maxLength":300,
            "type":"string",
            "description":"Agent first name.",
            "nullable":true,
            "x-queryable":true
        },
        "IsRecordEditable":{
            "maxLength":255,
            "type":"string",
            "description":"Editable record indicator.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "description":"Person identifier",
            "nullable":true,
            "x-queryable":true
        },
        "ContextId":{
            "type":"integer",
            "description":"Context identifier.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmissionId":{
            "type":"integer",
            "description":"Submission identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "PoolMemberId":{
            "type":"integer",
            "description":"Pool member identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "OrigSourceName":{
            "maxLength":255,
            "type":"string",
            "description":"Original source name.",
            "nullable":true,
            "x-queryable":true
        },
        "DimensionId":{
            "type":"integer",
            "description":"Dimension identifier.",
            "nullable":true,
            "x-queryable":true
        },
        "RequisitionTitle":{
            "title":"Job Requisition",
            "maxLength":255,
            "type":"string",
            "description":"Requisition title.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceMediumURLValue":{
            "maxLength":255,
            "type":"string",
            "description":"Source medium URL value.",
            "nullable":true,
            "x-queryable":true
        },
        "ProspectId":{
            "type":"integer",
            "description":"Prospect identifier.",
            "nullable":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"
    }
}

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