Jump to

• Request
• Response

Patch talent community sign up in recruitingCESites

patch

/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/talentCommunitySignUp/{Id}

Request

Path Parameters

• Id(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:
  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

• ButtonLabel: string
  Maximum Length: 1000

  Label of the buttons on the talent community sign up site.
• Description: string
  Maximum Length: 1000

  Description of the sign up in the talent community site.
• ShowAtSearchResultsFlag: boolean
  Indicates when search results appear on a site.
• ShowWhenNoSearchResultsFoundFlag: boolean
  Indicates when no results come up during a search executed on the recruitingCESites.
• Title: string
  Maximum Length: 1000

  Title assigned to each of the sign up in the talent community in the recruitingCESites.
• 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.

{
    "type":"object",
    "properties":{
        "ShowAtSearchResultsFlag":{
            "type":"boolean",
            "description":"Indicates when search results appear on a site.",
            "nullable":true
        },
        "Title":{
            "maxLength":"1000",
            "type":"string",
            "description":"Title assigned to each of the sign up in the talent community in the recruitingCESites.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the sign up in the talent community site.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "ButtonLabel":{
            "maxLength":"1000",
            "type":"string",
            "description":"Label of the buttons on the talent community sign up site.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "ShowWhenNoSearchResultsFoundFlag":{
            "type":"boolean",
            "description":"Indicates when no results come up during a search executed on the recruitingCESites.",
            "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-talentCommunitySignUp-translations-item-patch-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-talentCommunitySignUp-translations-item-patch-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-talentCommunitySignUp-translations-item-patch-request"
    }
}

Nested Schema : recruitingCESites-talentCommunitySignUp-translations-item-patch-request

Type: object

Show Source

• ButtonLabel: string
  Maximum Length: 1000

  Label of the button in talent community sign up.
• Description: string
  Maximum Length: 1000

  Description of the talent community sign up.
• Title: string
  Maximum Length: 1000

  Title of the talent community sign up.

{
    "type":"object",
    "properties":{
        "Title":{
            "maxLength":"1000",
            "type":"string",
            "description":"Title of the talent community sign up.",
            "nullable":true
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the talent community sign up.",
            "nullable":true
        },
        "ButtonLabel":{
            "maxLength":"1000",
            "type":"string",
            "description":"Label of the button in talent community sign up.",
            "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-talentCommunitySignUp-item-response

Type: object

Show Source

• ButtonLabel: string
  Maximum Length: 1000

  Label of the buttons on the talent community sign up site.
• Description: string
  Maximum Length: 1000

  Description of the sign up in the talent community site.
• Id: string
  Read Only: true

  Maximum Length: 255

  ID assigned to each sign up in the talent community.
• Language: string
  Read Only: true

  Maximum Length: 255

  Language used in the sign up in the talent community on the recruitingCESites..
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ShowAtSearchResultsFlag: boolean
  Indicates when search results appear on a site.
• ShowWhenNoSearchResultsFoundFlag: boolean
  Indicates when no results come up during a search executed on the recruitingCESites.
• SiteId: integer (int64)
  Site ID in talent community sign up.
• Title: string
  Maximum Length: 1000

  Title assigned to each of the sign up in the talent community in the recruitingCESites.
• 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.

{
    "type":"object",
    "properties":{
        "ShowAtSearchResultsFlag":{
            "type":"boolean",
            "description":"Indicates when search results appear on a site.",
            "nullable":true,
            "x-queryable":true
        },
        "SiteId":{
            "type":"integer",
            "description":"Site ID in talent community sign up.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the sign up in the talent community site.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "Language":{
            "maxLength":"255",
            "type":"string",
            "description":"Language used in the sign up in the talent community on the recruitingCESites..",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ButtonLabel":{
            "maxLength":"1000",
            "type":"string",
            "description":"Label of the buttons on the talent community sign up site.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":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-talentCommunitySignUp-translations-item-response"
            }
        },
        "Title":{
            "maxLength":"1000",
            "type":"string",
            "description":"Title assigned to each of the sign up in the talent community in the recruitingCESites.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "Id":{
            "maxLength":"255",
            "type":"string",
            "description":"ID assigned to each sign up in the talent community.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShowWhenNoSearchResultsFoundFlag":{
            "type":"boolean",
            "description":"Indicates when no results come up during a search executed on the recruitingCESites.",
            "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 : 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-talentCommunitySignUp-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-talentCommunitySignUp-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-talentCommunitySignUp-translations-item-response

Type: object

Show Source

• ButtonLabel: string
  Maximum Length: 1000

  Label of the button in talent community sign up.
• Description: string
  Maximum Length: 1000

  Description of the talent community sign up.
• Language: string
  Read Only: true

  Maximum Length: 4

  Language of the talent community sign up.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SiteId: integer (int64)
  Read Only: true

  Site ID in talent community sign up translation.
• SourceLang: string
  Read Only: true

  Maximum Length: 4

  Source language of the talent community sign up translation.
• Title: string
  Maximum Length: 1000

  Title of the talent community sign up.

{
    "type":"object",
    "properties":{
        "SiteId":{
            "type":"integer",
            "description":"Site ID in talent community sign up translation.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":"18",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "Description":{
            "maxLength":"1000",
            "type":"string",
            "description":"Description of the talent community sign up.",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":"4",
            "type":"string",
            "description":"Language of the talent community sign up.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ButtonLabel":{
            "maxLength":"1000",
            "type":"string",
            "description":"Label of the button in talent community sign up.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":"4",
            "type":"string",
            "description":"Source language of the talent community sign up translation.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Title":{
            "maxLength":"1000",
            "type":"string",
            "description":"Title of the talent community sign up.",
            "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/talentCommunitySignUp/{Id}/child/translations

Parameters:

• Id: $request.path.Id
• SiteNumber: $request.path.SiteNumber

The translations resource is a child of talentCommunitySignUp. It includes the talent community sign up related translations in the recruitingCESites. Note that the service endpoints in this resource category are only for Oracle internal use.

Back to Top