Jump to

• Request
• Response

Get all cookie consent in recruitingCESites

get

/hcmRestApi/resources/11.13.18.05/recruitingCESites/{SiteNumber}/child/cookieConsent

Request

Path Parameters

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

Query Parameters

• dependency: string
  This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
  
  Format: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
• fields: string
  This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.
  
  Format: ?fields=Attribute1,Attribute2
  
  Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  Used as a predefined finder to search the collection.
  
  Format ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  The following are the available finder names and corresponding finder variables
  
  

  • PrimaryKey Find cookie consent in recruitingCESites by unique ID
    Finder Variables
    • CookieId; integer; Find cookie consent in recruitingCESites by unique ID and CookieId; integer;
• limit: integer
  This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
• links: string
  This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>
  
  Example:
  self,canonical
  
• offset: integer
  Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
• onlyData: boolean
  The resource item payload will be filtered in order to contain only data (no links section, for example).
• orderBy: string
  This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
• q: string
  This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY
  
  Format: ?q=expression1;expression2
  
  You can use these queryable attributes to filter this collection resource using the q query parameter:
  

  • AcceptButtonLabel; string; Label of the accept button on the cookie consent page.
  • CookieId; integer; Cookie Id.
  • CookieLinkLabel; string; Label for the cookie policy link.
  • CookieMessageEnabledFlag; boolean; Indicates that the cookie is enabled on the page.
  • CookiePreferencesEnabledFlag; boolean; Indicates that the cookie preferences functionality is enabled.
  • CustomCategoryButtonLabel; string; Label for the button to add the custom category.
  • CustomCookieEnabledFlag; boolean; Indicates that the custom cookie category is enabled.
  • DeclineButtonEnabledFlag; boolean; Indicates that the decline cookies button is enabled on the page.
  • DeclineButtonLabel; string; Label assigned to the decline cookie button on the cookie consent page.
  • Language; string; Language of the cookie consent page.
  • PopUpMessage; string; Pop up message defined on the cookie consent page.
  • PreferencesButtonLabel; string; Label for the cookie preferences button.
  • PreferencesSaveButtonLabel; string; Label for the save preferences button.
  • SiteId; integer; Unique ID assigned to each site of the cookie consent.
• totalResults: boolean
  The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".

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.

There's no request body for this operation.

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-cookieConsent

Type: object

Show Source

• count(required): integer
  The number of resource instances returned in the current range.
• hasMore(required): boolean
  Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
• items: array Items
  Title: Items

  The items in the collection.
• limit(required): integer
  The actual paging size used by the server.
• links(required): array Links
  Title: Links

  The link relations associated with the resource instance.
• offset(required): integer
  The offset value used in the current page.
• totalResults: integer
  The estimated row count when "?totalResults=true", otherwise the count is not included.

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/recruitingCESites-cookieConsent-item-response"
            },
            "x-cardinality":"1"
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object recruitingCESites-cookieConsent-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/recruitingCESites-cookieConsent-item-response"
    },
    "x-cardinality":"1"
}

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 : recruitingCESites-cookieConsent-item-response

Type: object

Show Source

• AcceptButtonLabel: string
  Maximum Length: 4000

  Label of the accept button on the cookie consent page.
• AnalyticalCategoryMessage: string (byte)
  Description for the analytical cookie category.
• CookieId: integer (int64)
  Cookie Id.
• CookieLinkLabel: string
  Maximum Length: 4000

  Label for the cookie policy link.
• CookieMessageEnabledFlag: boolean
  Indicates that the cookie is enabled on the page.
• CookiePreferencesEnabledFlag: boolean
  Indicates that the cookie preferences functionality is enabled.
• CustomCategoryButtonLabel: string
  Maximum Length: 4000

  Label for the button to add the custom category.
• CustomCategoryDescription: string (byte)
  Description for the custom cookie category.
• CustomCookieEnabledFlag: boolean
  Indicates that the custom cookie category is enabled.
• DeclineButtonEnabledFlag: boolean
  Indicates that the decline cookies button is enabled on the page.
• DeclineButtonLabel: string
  Maximum Length: 4000

  Label assigned to the decline cookie button on the cookie consent page.
• FunctionalCategoryMessage: string (byte)
  Description for the functional cookie category.
• Language: string
  Read Only: true

  Maximum Length: 255

  Language of the cookie consent page.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PolicyMessage: string (byte)
  Policy details on the cookie consent page.
• PopUpMessage: string
  Maximum Length: 4000

  Pop up message defined on the cookie consent page.
• PreferencesButtonLabel: string
  Maximum Length: 4000

  Label for the cookie preferences button.
• PreferencesSaveButtonLabel: string
  Maximum Length: 4000

  Label for the save preferences button.
• SiteId: integer (int64)
  Unique ID assigned to each site of the cookie consent.
• StrictCategoryMessage: string (byte)
  Description for the strictly necessary cookie category.
• 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":{
        "SiteId":{
            "type":"integer",
            "description":"Unique ID assigned to each site of the cookie consent.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show",
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "CustomCategoryButtonLabel":{
            "maxLength":4000,
            "type":"string",
            "description":"Label for the button to add the custom category.",
            "nullable":true,
            "x-queryable":true
        },
        "CookiePreferencesEnabledFlag":{
            "type":"boolean",
            "description":"Indicates that the cookie preferences functionality is enabled.",
            "nullable":true,
            "x-queryable":true
        },
        "DeclineButtonLabel":{
            "maxLength":4000,
            "type":"string",
            "description":"Label assigned to the decline cookie button on the cookie consent page.",
            "nullable":true,
            "x-queryable":true
        },
        "PolicyMessage":{
            "type":"string",
            "description":"Policy details on the cookie consent page.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CustomCookieEnabledFlag":{
            "type":"boolean",
            "description":"Indicates that the custom cookie category is enabled.",
            "nullable":true,
            "x-queryable":true
        },
        "PreferencesButtonLabel":{
            "maxLength":4000,
            "type":"string",
            "description":"Label for the cookie preferences button.",
            "nullable":true,
            "x-queryable":true
        },
        "CookieLinkLabel":{
            "maxLength":4000,
            "type":"string",
            "description":"Label for the cookie policy link.",
            "nullable":true,
            "x-queryable":true
        },
        "FunctionalCategoryMessage":{
            "type":"string",
            "description":"Description for the functional cookie category.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "DeclineButtonEnabledFlag":{
            "type":"boolean",
            "description":"Indicates that the decline cookies button is enabled on the page.",
            "nullable":true,
            "x-queryable":true
        },
        "Language":{
            "maxLength":255,
            "type":"string",
            "description":"Language of the cookie consent page.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PopUpMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Pop up message defined on the cookie consent page.",
            "nullable":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-cookieConsent-translations-item-response"
            }
        },
        "AcceptButtonLabel":{
            "maxLength":4000,
            "type":"string",
            "description":"Label of the accept button on the cookie consent page.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomCategoryDescription":{
            "type":"string",
            "description":"Description for the custom cookie category.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CookieMessageEnabledFlag":{
            "type":"boolean",
            "description":"Indicates that the cookie is enabled on the page.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AnalyticalCategoryMessage":{
            "type":"string",
            "description":"Description for the analytical cookie category.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "StrictCategoryMessage":{
            "type":"string",
            "description":"Description for the strictly necessary cookie category.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PreferencesSaveButtonLabel":{
            "maxLength":4000,
            "type":"string",
            "description":"Label for the save preferences button.",
            "nullable":true,
            "x-queryable":true
        },
        "CookieId":{
            "type":"integer",
            "description":"Cookie Id.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show"
            },
            "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-cookieConsent-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-cookieConsent-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-cookieConsent-translations-item-response

Type: object

Show Source

• AcceptButtonLabel: string
  Maximum Length: 4000

  Label of the accept button for cookie consent.
• AnalyticalCategoryMessage: string (byte)
  Analytical cookie category description translation.
• CookieId: integer (int64)
  Unique ID assigned to each cookie for the consent translations.
• CookieLinkLabel: string
  Maximum Length: 4000

  Cookie policy link label translation.
• CustomCategoryButtonLabel: string
  Maximum Length: 4000

  Translated label for the add custom cookie category button.
• CustomCategoryDescription: string (byte)
  Custom cookie category description translation.
• DeclineButtonLabel: string
  Maximum Length: 4000

  Label of the decline button for cookie consent.
• FunctionalCategoryMessage: string (byte)
  Functional cookie category description translation.
• Language: string
  Maximum Length: 4

  Language of the translations on the cookie consent site.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PolicyMessage: string (byte)
  Policy message in the cookie consent translations.
• PopUpMessage: string
  Maximum Length: 4000

  Message that pops up in the cookie consent translations.
• PreferencesButtonLabel: string
  Maximum Length: 4000

  Cookie preferences button label translation.
• PreferencesSaveButtonLabel: string
  Maximum Length: 4000

  Save preferences button label translation.
• SourceLang: string
  Maximum Length: 4

  Source language of the translations on the cookie consent site.
• StrictCategoryMessage: string (byte)
  Strictly necessary cookie category description translation.

{
    "type":"object",
    "properties":{
        "CustomCategoryButtonLabel":{
            "maxLength":4000,
            "type":"string",
            "description":"Translated label for the add custom cookie category button.",
            "nullable":true,
            "x-queryable":true
        },
        "DeclineButtonLabel":{
            "maxLength":4000,
            "type":"string",
            "description":"Label of the decline button for cookie consent.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Source language of the translations on the cookie consent site.",
            "nullable":false,
            "x-queryable":true
        },
        "PolicyMessage":{
            "type":"string",
            "description":"Policy message in the cookie consent translations.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PreferencesButtonLabel":{
            "maxLength":4000,
            "type":"string",
            "description":"Cookie preferences button label translation.",
            "nullable":true,
            "x-queryable":true
        },
        "CookieLinkLabel":{
            "maxLength":4000,
            "type":"string",
            "description":"Cookie policy link label translation.",
            "nullable":true,
            "x-queryable":true
        },
        "FunctionalCategoryMessage":{
            "type":"string",
            "description":"Functional cookie category description translation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language of the translations on the cookie consent site.",
            "nullable":false,
            "x-queryable":true
        },
        "PopUpMessage":{
            "maxLength":4000,
            "type":"string",
            "description":"Message that pops up in the cookie consent translations.",
            "nullable":true,
            "x-queryable":true
        },
        "AcceptButtonLabel":{
            "maxLength":4000,
            "type":"string",
            "description":"Label of the accept button for cookie consent.",
            "nullable":true,
            "x-queryable":true
        },
        "CustomCategoryDescription":{
            "type":"string",
            "description":"Custom cookie category description translation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AnalyticalCategoryMessage":{
            "type":"string",
            "description":"Analytical cookie category description translation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "PreferencesSaveButtonLabel":{
            "maxLength":4000,
            "type":"string",
            "description":"Save preferences button label translation.",
            "nullable":true,
            "x-queryable":true
        },
        "StrictCategoryMessage":{
            "type":"string",
            "description":"Strictly necessary cookie category description translation.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false
        },
        "CookieId":{
            "type":"integer",
            "description":"Unique ID assigned to each cookie for the consent translations.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "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"
    }
}

Back to Top