Jump to

• Request
• Response

Submit all details of candidate referrals

post

/hcmRestApi/resources/11.13.18.05/recruitingCEReferrals

Request

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

• attachments: array Attachments in Referrals
  Title: Attachments in Referrals

  The attachments resource is a child of recruitingCEReferrals. It includes all the attachments for referrals. Note that the service endpoints in this resource category are only for Oracle internal use.
• ReferralId: integer (int64)
  Referrer ID for candidate referral.

{
    "type":"object",
    "properties":{
        "ReferralId":{
            "type":"integer",
            "description":"Referrer ID for candidate referral.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            }
        },
        "attachments":{
            "title":"Attachments in Referrals",
            "type":"array",
            "description":"The attachments resource is a child of recruitingCEReferrals. It includes all the attachments for referrals. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEReferrals-attachments-item-post-request"
            }
        }
    }
}

Nested Schema : Attachments in Referrals

Type: array

Title: Attachments in Referrals

The attachments resource is a child of recruitingCEReferrals. It includes all the attachments for referrals. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCEReferrals-attachments-item-post-request

{
    "title":"Attachments in Referrals",
    "type":"array",
    "description":"The attachments resource is a child of recruitingCEReferrals. It includes all the attachments for referrals. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEReferrals-attachments-item-post-request"
    }
}

Nested Schema : recruitingCEReferrals-attachments-item-post-request

Type: object

Show Source

• AttachmentName: string
  Title: File Name

  Maximum Length: 2048

  Attachment Name for attachments in candidate referral.
• DocumentId: integer (int64)
  ID assigned to candidate referral attachment.
• MimeType: string
  Mime type for attachments in candidate referral.
• Type: string
  Maximum Length: 30

  Type for attachments in candidate referral.

{
    "type":"object",
    "properties":{
        "DocumentId":{
            "type":"integer",
            "description":"ID assigned to candidate referral attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            }
        },
        "Type":{
            "maxLength":"30",
            "type":"string",
            "description":"Type for attachments in candidate referral.",
            "nullable":true
        },
        "AttachmentName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"Attachment Name for attachments in candidate referral.",
            "nullable":true
        },
        "MimeType":{
            "type":"string",
            "description":"Mime type for attachments in candidate referral.",
            "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 : recruitingCEReferrals-item-response

Type: object

Show Source

• attachments: array Attachments in Referrals
  Title: Attachments in Referrals

  The attachments resource is a child of recruitingCEReferrals. It includes all the attachments for referrals. Note that the service endpoints in this resource category are only for Oracle internal use.
• CandidateName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Candidate Name for candidate referral.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• RefererName: string
  Title: Name

  Read Only: true

  Maximum Length: 240

  Referrer Name for candidate referral.
• ReferralId: integer (int64)
  Referrer ID for candidate referral.
• RequisitionId: integer (int64)
  Read Only: true

  Requisition ID for candidate referral.
• Status: string
  Read Only: true

  Maximum Length: 40

  Status of candidate referral.

{
    "type":"object",
    "properties":{
        "Status":{
            "maxLength":"40",
            "type":"string",
            "description":"Status of candidate referral.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequisitionId":{
            "type":"integer",
            "description":"Requisition ID for candidate referral.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "attachments":{
            "title":"Attachments in Referrals",
            "type":"array",
            "description":"The attachments resource is a child of recruitingCEReferrals. It includes all the attachments for referrals. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCEReferrals-attachments-item-response"
            }
        },
        "CandidateName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Candidate Name for candidate referral.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReferralId":{
            "type":"integer",
            "description":"Referrer ID for candidate referral.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "RefererName":{
            "title":"Name",
            "maxLength":"240",
            "type":"string",
            "description":"Referrer Name for candidate referral.",
            "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"
            }
        }
    }
}

Nested Schema : Attachments in Referrals

Type: array

Title: Attachments in Referrals

The attachments resource is a child of recruitingCEReferrals. It includes all the attachments for referrals. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCEReferrals-attachments-item-response

{
    "title":"Attachments in Referrals",
    "type":"array",
    "description":"The attachments resource is a child of recruitingCEReferrals. It includes all the attachments for referrals. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCEReferrals-attachments-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 : recruitingCEReferrals-attachments-item-response

Type: object

Show Source

• AttachmentContents: string
  Read Only: true

  Attachment Contents for attachments in candidate referral.
• AttachmentId: integer (int64)
  Read Only: true

  Attachment ID for attachments in candidate referral.
• AttachmentName: string
  Title: File Name

  Maximum Length: 2048

  Attachment Name for attachments in candidate referral.
• Category: string
  Title: Category

  Read Only: true

  Maximum Length: 30

  Category for attachments in candidate referral.
• DocumentId: integer (int64)
  ID assigned to candidate referral attachment.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MimeType: string
  Mime type for attachments in candidate referral.
• Type: string
  Maximum Length: 30

  Type for attachments in candidate referral.

{
    "type":"object",
    "properties":{
        "Type":{
            "maxLength":"30",
            "type":"string",
            "description":"Type for attachments in candidate referral.",
            "nullable":true,
            "x-queryable":true
        },
        "Category":{
            "title":"Category",
            "maxLength":"30",
            "type":"string",
            "description":"Category for attachments in candidate referral.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentName":{
            "title":"File Name",
            "maxLength":"2048",
            "type":"string",
            "description":"Attachment Name for attachments in candidate referral.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentId":{
            "type":"integer",
            "description":"ID assigned to candidate referral attachment.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AttachmentContents":{
            "type":"string",
            "description":"Attachment Contents for attachments in candidate referral.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AttachmentId":{
            "type":"integer",
            "description":"Attachment ID for attachments in candidate referral.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "MimeType":{
            "type":"string",
            "description":"Mime type for attachments in candidate referral.",
            "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."
        }
    }
}

Links

attachments

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCEReferrals/{ReferralId}/child/attachments

Parameters:

• ReferralId: $request.path.ReferralId

The attachments resource is a child of recruitingCEReferrals. It includes all the attachments for referrals. Note that the service endpoints in this resource category are only for Oracle internal use.

Back to Top