Jump to

• Request
• Response

Submit all child links used in the recruiting site

post

/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks

Request

Path Parameters

• LinkNumber(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=
• SiteNumber(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: 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.
• Upsert-Mode: string
  Contains one of the following values: true or false. If true, the server performs an Upsert operation instead of a Create operation. During an Upsert operation, the server attempts to find an existing resource that matches the payload. If a match is found, the server updates the existing resource instead of creating a new one. If not found or false (default), the server performs a Create operation. Note that the Upsert operation isn't supported for date-effective REST resources.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• IsVisibleFlag: boolean
  Maximum Length: 1

  Language for the header sublink translation.
• LinkDescription: string
  Maximum Length: 4000

  Link description for the header sublink.
• LinkId: integer (int64)
  Unique ID assigned to each header sublink.
• LinkName: string
  Maximum Length: 4000

  Name of the child links.
• LinkNumber(required): string
  Maximum Length: 240

  Number of the child links.
• LinkOrder(required): integer (int64)
  Order of the child links.
• LinkText: string
  Maximum Length: 240

  Text of the child links.
• LinkTypeCode(required): string
  Maximum Length: 45

  Code assigned to the type of child links.
• LinkURL: string
  Maximum Length: 2048

  URL of the child links.
• ParentLinkNumber: string
  Maximum Length: 240

  Number assigned to the parent of the child links.
• SiteNumber(required): string
  Maximum Length: 240

  Site number for the header sublink.
• ThumbnailURL: string
  Maximum Length: 2048

  Thumbnail URL for the header sublink.
• translations: array Header Link Translations
  Title: Header Link Translations

  The translations resource is a child of cookieConsent. It includes translations of the cookie consent in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
• VisibleOnMobile: boolean
  Indicates if the child links are visible on mobile.

{
    "required":[
        "LinkNumber",
        "LinkOrder",
        "LinkTypeCode",
        "SiteNumber"
    ],
    "type":"object",
    "properties":{
        "IsVisibleFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Language for the header sublink translation.",
            "nullable":true
        },
        "LinkDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Link description for the header sublink.",
            "nullable":true
        },
        "LinkId":{
            "type":"integer",
            "description":"Unique ID assigned to each header sublink.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show",
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "LinkName":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the child links.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "LinkNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Number of the child links.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "LinkOrder":{
            "type":"integer",
            "description":"Order of the child links.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "LinkText":{
            "maxLength":240,
            "type":"string",
            "description":"Text of the child links.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "LinkTypeCode":{
            "maxLength":45,
            "type":"string",
            "description":"Code assigned to the type of child links.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "LinkURL":{
            "maxLength":2048,
            "type":"string",
            "description":"URL of the child links.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "ParentLinkNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Number assigned to the parent of the child links.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "SiteNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Site number for the header sublink.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "ThumbnailURL":{
            "maxLength":2048,
            "type":"string",
            "description":"Thumbnail URL for the header sublink.",
            "nullable":true
        },
        "VisibleOnMobile":{
            "type":"boolean",
            "description":"Indicates if the child links are visible on mobile.",
            "nullable":true
        },
        "translations":{
            "title":"Header Link Translations",
            "type":"array",
            "description":"The translations resource is a child of cookieConsent. It includes translations of the cookie consent in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCESites-headerLinks-sublinks-translations-item-post-request"
            }
        }
    }
}

Nested Schema : Header Link Translations

Type: array

Title: Header Link Translations

The translations resource is a child of cookieConsent. It includes translations of the cookie consent in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCESites-headerLinks-sublinks-translations-item-post-request

{
    "title":"Header Link Translations",
    "type":"array",
    "description":"The translations resource is a child of cookieConsent. It includes translations of the cookie consent in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCESites-headerLinks-sublinks-translations-item-post-request"
    }
}

Nested Schema : recruitingCESites-headerLinks-sublinks-translations-item-post-request

Type: object

Show Source

• Language: string
  Maximum Length: 4

  Language of the header translation.
• LinkDescription: string
  Maximum Length: 4000

  Link description assigned to each header link translation.
• LinkId: integer (int64)
  Unique ID assigned to each header link translation.
• LinkName: string
  Maximum Length: 1000

  Link name of the header translation.
• LinkText: string
  Maximum Length: 240

  Link text of the header translation.
• LinkURL: string
  Maximum Length: 2048

  Link URL of the header translation.
• SourceLang: string
  Maximum Length: 4

  Source language of the header translation.
• ThumbnailURL: string
  Maximum Length: 2048

  Thumbnail URL for the header link translation.

{
    "type":"object",
    "properties":{
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language of the header translation.",
            "nullable":false
        },
        "LinkDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Link description assigned to each header link translation.",
            "nullable":true
        },
        "LinkId":{
            "type":"integer",
            "description":"Unique ID assigned to each header link translation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            }
        },
        "LinkName":{
            "maxLength":1000,
            "type":"string",
            "description":"Link name of the header translation.",
            "nullable":true
        },
        "LinkText":{
            "maxLength":240,
            "type":"string",
            "description":"Link text of the header translation.",
            "nullable":true
        },
        "LinkURL":{
            "maxLength":2048,
            "type":"string",
            "description":"Link URL of the header translation.",
            "nullable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Source language of the header translation.",
            "nullable":false
        },
        "ThumbnailURL":{
            "maxLength":2048,
            "type":"string",
            "description":"Thumbnail URL for the header link translation.",
            "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 : recruitingCESites-headerLinks-sublinks-item-response

Type: object

Show Source

• IsVisibleFlag: boolean
  Maximum Length: 1

  Language for the header sublink translation.
• Language: string
  Read Only: true

  Maximum Length: 255

  Language of the child links.
• LinkDescription: string
  Maximum Length: 4000

  Link description for the header sublink.
• LinkId: integer (int64)
  Unique ID assigned to each header sublink.
• LinkName: string
  Maximum Length: 4000

  Name of the child links.
• LinkNumber: string
  Maximum Length: 240

  Number of the child links.
• LinkOrder: integer (int64)
  Order of the child links.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LinkText: string
  Maximum Length: 240

  Text of the child links.
• LinkTypeCode: string
  Maximum Length: 45

  Code assigned to the type of child links.
• LinkURL: string
  Maximum Length: 2048

  URL of the child links.
• ParentLinkNumber: string
  Maximum Length: 240

  Number assigned to the parent of the child links.
• SiteNumber: string
  Maximum Length: 240

  Site number for the header sublink.
• ThumbnailURL: string
  Maximum Length: 2048

  Thumbnail URL for the header sublink.
• translations: array Header Link Translations
  Title: Header Link Translations

  The translations resource is a child of cookieConsent. It includes translations of the cookie consent in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.
• VisibleOnMobile: boolean
  Indicates if the child links are visible on mobile.

{
    "type":"object",
    "properties":{
        "IsVisibleFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Language for the header sublink translation.",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":255,
            "type":"string",
            "description":"Language of the child links.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LinkDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Link description for the header sublink.",
            "nullable":true,
            "x-queryable":true
        },
        "LinkId":{
            "type":"integer",
            "description":"Unique ID assigned to each header sublink.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show",
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "LinkName":{
            "maxLength":4000,
            "type":"string",
            "description":"Name of the child links.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "LinkNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Number of the child links.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "LinkOrder":{
            "type":"integer",
            "description":"Order of the child links.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "LinkText":{
            "maxLength":240,
            "type":"string",
            "description":"Text of the child links.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "LinkTypeCode":{
            "maxLength":45,
            "type":"string",
            "description":"Code assigned to the type of child links.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "LinkURL":{
            "maxLength":2048,
            "type":"string",
            "description":"URL of the child links.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "ParentLinkNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Number assigned to the parent of the child links.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "SiteNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Site number for the header sublink.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "ThumbnailURL":{
            "maxLength":2048,
            "type":"string",
            "description":"Thumbnail URL for the header sublink.",
            "nullable":true,
            "x-queryable":true
        },
        "VisibleOnMobile":{
            "type":"boolean",
            "description":"Indicates if the child links are visible on mobile.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "translations":{
            "title":"Header Link Translations",
            "type":"array",
            "description":"The translations resource is a child of cookieConsent. It includes translations of the cookie consent in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.",
            "items":{
                "$ref":"#/components/schemas/recruitingCESites-headerLinks-sublinks-translations-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 : Header Link Translations

Type: array

Title: Header Link Translations

The translations resource is a child of cookieConsent. It includes translations of the cookie consent in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.

Show Source

• Array of: object recruitingCESites-headerLinks-sublinks-translations-item-response

{
    "title":"Header Link Translations",
    "type":"array",
    "description":"The translations resource is a child of cookieConsent. It includes translations of the cookie consent in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.",
    "items":{
        "$ref":"#/components/schemas/recruitingCESites-headerLinks-sublinks-translations-item-response"
    }
}

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 : recruitingCESites-headerLinks-sublinks-translations-item-response

Type: object

Show Source

• Language: string
  Maximum Length: 4

  Language of the header translation.
• LinkDescription: string
  Maximum Length: 4000

  Link description assigned to each header link translation.
• LinkId: integer (int64)
  Unique ID assigned to each header link translation.
• LinkName: string
  Maximum Length: 1000

  Link name of the header translation.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LinkText: string
  Maximum Length: 240

  Link text of the header translation.
• LinkURL: string
  Maximum Length: 2048

  Link URL of the header translation.
• SourceLang: string
  Maximum Length: 4

  Source language of the header translation.
• ThumbnailURL: string
  Maximum Length: 2048

  Thumbnail URL for the header link translation.

{
    "type":"object",
    "properties":{
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language of the header translation.",
            "nullable":false,
            "x-queryable":true
        },
        "LinkDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Link description assigned to each header link translation.",
            "nullable":true,
            "x-queryable":true
        },
        "LinkId":{
            "type":"integer",
            "description":"Unique ID assigned to each header link translation.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "LinkName":{
            "maxLength":1000,
            "type":"string",
            "description":"Link name of the header translation.",
            "nullable":true,
            "x-queryable":true
        },
        "LinkText":{
            "maxLength":240,
            "type":"string",
            "description":"Link text of the header translation.",
            "nullable":true,
            "x-queryable":true
        },
        "LinkURL":{
            "maxLength":2048,
            "type":"string",
            "description":"Link URL of the header translation.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Source language of the header translation.",
            "nullable":false,
            "x-queryable":true
        },
        "ThumbnailURL":{
            "maxLength":2048,
            "type":"string",
            "description":"Thumbnail URL for the header link translation.",
            "nullable":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 : 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

translations

Operation: /hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/headerLinks/{LinkNumber}/child/sublinks/{LinkNumber4}/child/translations

Parameters:

• LinkNumber3: $request.path.LinkNumber3
• LinkNumber4: $request.path.LinkNumber4
• SiteNumber: $request.path.SiteNumber

The translations resource is a child of headerLinks. It includes translations of the header links in recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.

Back to Top