Jump to

• Request
• Response

Create extra information row about candidates

post

/hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextCode}/child/dataRows

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=
• ContextCode(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=

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

• attributes: array Extra Information Attributes of the Candidates
  Title: Extra Information Attributes of the Candidates

  The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
• ContextRowId: string
  Maximum Length: 255

  Context row identifier of the candidate extra information data rows.
• ContextRowLink: string
  Maximum Length: 255

  Context row link of the candidate extra information data rows.
• DataId: integer
  Data identifier of the candidate extra information data rows.
• DataRowId: integer
  Data row identifier of the candidate extra information data rows.
• RowAction: string
  Maximum Length: 255

  Row action that needs to be performed on the candidate extra information data rows.

{
    "type":"object",
    "properties":{
        "attributes":{
            "title":"Extra Information Attributes of the Candidates",
            "type":"array",
            "description":"The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
            "items":{
                "$ref":"#/components/schemas/recruitingJobSiteCandidates-candidateExtraInformation-dataRows-attributes-item-post-request"
            }
        },
        "DataId":{
            "type":"integer",
            "description":"Data identifier of the candidate extra information data rows.",
            "nullable":true
        },
        "ContextRowId":{
            "maxLength":"255",
            "type":"string",
            "description":"Context row identifier of the candidate extra information data rows.",
            "nullable":true
        },
        "DataRowId":{
            "type":"integer",
            "description":"Data row identifier of the candidate extra information data rows.",
            "nullable":true
        },
        "ContextRowLink":{
            "maxLength":"255",
            "type":"string",
            "description":"Context row link of the candidate extra information data rows.",
            "nullable":true
        },
        "RowAction":{
            "maxLength":"255",
            "type":"string",
            "description":"Row action that needs to be performed on the candidate extra information data rows.",
            "nullable":true
        }
    }
}

Nested Schema : Extra Information Attributes of the Candidates

Type: array

Title: Extra Information Attributes of the Candidates

The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Show Source

• Array of: object schema

{
    "title":"Extra Information Attributes of the Candidates",
    "type":"array",
    "description":"The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
    "items":{
        "$ref":"#/components/schemas/recruitingJobSiteCandidates-candidateExtraInformation-dataRows-attributes-item-post-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• AttributeId: integer
  Attribute identifier of the candidate extra information data row attribute.
• DataRowId: integer
  Data row identifier of the candidate extra information data row attribute.
• Name: string
  Name of the candidate extra information data row attribute.
• Value: string
  Value of the candidate extra information data row attribute.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string",
            "description":"Value of the candidate extra information data row attribute.",
            "nullable":true
        },
        "DataRowId":{
            "type":"integer",
            "description":"Data row identifier of the candidate extra information data row attribute.",
            "nullable":true
        },
        "AttributeId":{
            "type":"integer",
            "description":"Attribute identifier of the candidate extra information data row attribute.",
            "nullable":true
        },
        "Name":{
            "type":"string",
            "description":"Name of the candidate extra information data row attribute.",
            "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 : recruitingJobSiteCandidates-candidateExtraInformation-dataRows-item-response

Type: object

Show Source

• attributes: array Extra Information Attributes of the Candidates
  Title: Extra Information Attributes of the Candidates

  The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.
• ContextRowId: string
  Maximum Length: 255

  Context row identifier of the candidate extra information data rows.
• ContextRowLink: string
  Maximum Length: 255

  Context row link of the candidate extra information data rows.
• DataId: integer
  Data identifier of the candidate extra information data rows.
• DataRowId: integer
  Data row identifier of the candidate extra information data rows.
• links: array Links
  Title: Links

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

  Row action that needs to be performed on the candidate extra information data rows.

{
    "type":"object",
    "properties":{
        "DataId":{
            "type":"integer",
            "description":"Data identifier of the candidate extra information data rows.",
            "nullable":true,
            "x-queryable":true
        },
        "ContextRowId":{
            "maxLength":"255",
            "type":"string",
            "description":"Context row identifier of the candidate extra information data rows.",
            "nullable":true,
            "x-queryable":true
        },
        "ContextRowLink":{
            "maxLength":"255",
            "type":"string",
            "description":"Context row link of the candidate extra information data rows.",
            "nullable":true,
            "x-queryable":true
        },
        "RowAction":{
            "maxLength":"255",
            "type":"string",
            "description":"Row action that needs to be performed on the candidate extra information data rows.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "attributes":{
            "title":"Extra Information Attributes of the Candidates",
            "type":"array",
            "description":"The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
            "items":{
                "$ref":"#/components/schemas/recruitingJobSiteCandidates-candidateExtraInformation-dataRows-attributes-item-response"
            }
        },
        "DataRowId":{
            "type":"integer",
            "description":"Data row identifier of the candidate extra information data rows.",
            "nullable":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Extra Information Attributes of the Candidates

Type: array

Title: Extra Information Attributes of the Candidates

The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Show Source

• Array of: object recruitingJobSiteCandidates-candidateExtraInformation-dataRows-attributes-item-response

{
    "title":"Extra Information Attributes of the Candidates",
    "type":"array",
    "description":"The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.",
    "items":{
        "$ref":"#/components/schemas/recruitingJobSiteCandidates-candidateExtraInformation-dataRows-attributes-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 : recruitingJobSiteCandidates-candidateExtraInformation-dataRows-attributes-item-response

Type: object

Show Source

• AttributeId: integer
  Attribute identifier of the candidate extra information data row attribute.
• DataRowId: integer
  Data row identifier of the candidate extra information data row attribute.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• Name: string
  Name of the candidate extra information data row attribute.
• Value: string
  Value of the candidate extra information data row attribute.

{
    "type":"object",
    "properties":{
        "Value":{
            "type":"string",
            "description":"Value of the candidate extra information data row attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DataRowId":{
            "type":"integer",
            "description":"Data row identifier of the candidate extra information data row attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "AttributeId":{
            "type":"integer",
            "description":"Attribute identifier of the candidate extra information data row attribute.",
            "nullable":true,
            "x-queryable":true
        },
        "Name":{
            "type":"string",
            "description":"Name of the candidate extra information data row attribute.",
            "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."
        }
    }
}

Links

attributes

Operation: /hcmRestApi/resources/11.13.18.05/recruitingJobSiteCandidates/{CandidateNumber}/child/candidateExtraInformation/{ContextCode}/child/dataRows/{DataRowId}/child/attributes

Parameters:

• CandidateNumber: $request.path.CandidateNumber
• ContextCode: $request.path.ContextCode
• DataRowId: $request.path.DataRowId

The attributes resource is a child of the recruitingJobSiteCandidates resource. It provides row attributes containing extra information about the candidates. Note that the service endpoints in this resource category can only be used by approved Oracle Cloud Marketplace partners.

Back to Top