Jump to

• Request
• Response

Update details for a site link

patch

/hcmRestApi/resources/11.13.18.05/recruitingCESiteTileDetails/{LinkId}

Request

Path Parameters

• LinkId(required): integer(int64)
  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.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• IsVisibleFlag: boolean
  Maximum Length: 1

  Indicates whether the site tile should be visible or not.
• LinkDescription: string
  Maximum Length: 4000

  Link description provided during the site configuration.
• LinkName: string
  Maximum Length: 4000

  Link name provided during the site configuration.
• LinkOrder: integer (int64)
  Link order provided during the site configuration.
• LinkText: string
  Maximum Length: 240

  Link text or summary provided during the site configuration.
• LinkTypeCode: string
  Maximum Length: 45

  Link type code like job category, discovery, header, footer provided during the site configuration.
• LinkURL: string
  Maximum Length: 2048

  Link URL code provided during the site configuration.
• SiteNumber: string
  Maximum Length: 240

  Site number provided during the site configuration.
• ThumbnailURL: string
  Maximum Length: 2048

  Thumbnail URL provided during the site configuration.
• VisibleOnMobile: boolean
  Indicates whether the link is visible on mobile and is provided during site configuration.

{
    "type":"object",
    "properties":{
        "LinkName":{
            "maxLength":4000,
            "type":"string",
            "description":"Link name provided during the site configuration.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "IsVisibleFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the site tile should be visible or not.",
            "nullable":true
        },
        "LinkURL":{
            "maxLength":2048,
            "type":"string",
            "description":"Link URL code provided during the site configuration.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            }
        },
        "VisibleOnMobile":{
            "type":"boolean",
            "description":"Indicates whether the link is visible on mobile and is provided during site configuration.",
            "nullable":true
        },
        "ThumbnailURL":{
            "maxLength":2048,
            "type":"string",
            "description":"Thumbnail URL provided during the site configuration.",
            "nullable":true
        },
        "LinkDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Link description provided during the site configuration.",
            "nullable":true
        },
        "LinkTypeCode":{
            "maxLength":45,
            "type":"string",
            "description":"Link type code like job category, discovery, header, footer provided during the site configuration.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "LinkOrder":{
            "type":"integer",
            "description":"Link order provided during the site configuration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "SiteNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Site number provided during the site configuration.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            }
        },
        "LinkText":{
            "maxLength":240,
            "type":"string",
            "description":"Link text or summary provided during the site configuration.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"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 : recruitingCESiteTileDetails-item-response

Type: object

Show Source

• IsVisibleFlag: boolean
  Maximum Length: 1

  Indicates whether the site tile should be visible or not.
• Language: string
  Read Only: true

  Maximum Length: 255

  Language used by the site link.
• LinkDescription: string
  Maximum Length: 4000

  Link description provided during the site configuration.
• LinkId: integer (int64)
  Unique identifier used for the site link.
• LinkName: string
  Maximum Length: 4000

  Link name provided during the site configuration.
• LinkNumber: string
  Maximum Length: 240

  Link number provided during the site configuration.
• LinkOrder: integer (int64)
  Link order provided during the site configuration.
• links: array Links
  Title: Links

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

  Link text or summary provided during the site configuration.
• LinkTypeCode: string
  Maximum Length: 45

  Link type code like job category, discovery, header, footer provided during the site configuration.
• LinkURL: string
  Maximum Length: 2048

  Link URL code provided during the site configuration.
• ParentLinkNumber: string
  Maximum Length: 240

  Parent link number provided during the site configuration.
• SiteNumber: string
  Maximum Length: 240

  Site number provided during the site configuration.
• ThumbnailURL: string
  Maximum Length: 2048

  Thumbnail URL provided during the site configuration.
• VisibleOnMobile: boolean
  Indicates whether the link is visible on mobile and is provided during site configuration.

{
    "type":"object",
    "properties":{
        "LinkName":{
            "maxLength":4000,
            "type":"string",
            "description":"Link name provided during the site configuration.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "IsVisibleFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the site tile should be visible or not.",
            "nullable":true,
            "x-queryable":true
        },
        "ThumbnailURL":{
            "maxLength":2048,
            "type":"string",
            "description":"Thumbnail URL provided during the site configuration.",
            "nullable":true,
            "x-queryable":true
        },
        "LinkDescription":{
            "maxLength":4000,
            "type":"string",
            "description":"Link description provided during the site configuration.",
            "nullable":true,
            "x-queryable":true
        },
        "LinkOrder":{
            "type":"integer",
            "description":"Link order provided during the site configuration.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "SiteNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Site number provided during the site configuration.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "LinkText":{
            "maxLength":240,
            "type":"string",
            "description":"Link text or summary provided during the site configuration.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "ParentLinkNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Parent link number provided during the site configuration.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "LinkURL":{
            "maxLength":2048,
            "type":"string",
            "description":"Link URL code provided during the site configuration.",
            "nullable":true,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "Language":{
            "maxLength":255,
            "type":"string",
            "description":"Language used by the site link.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "VisibleOnMobile":{
            "type":"boolean",
            "description":"Indicates whether the link is visible on mobile and is provided during site configuration.",
            "nullable":true,
            "x-queryable":true
        },
        "LinkTypeCode":{
            "maxLength":45,
            "type":"string",
            "description":"Link type code like job category, discovery, header, footer provided during the site configuration.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LinkNumber":{
            "maxLength":240,
            "type":"string",
            "description":"Link number provided during the site configuration.",
            "nullable":false,
            "x-hints":{
                "fnd:OA_TRANSLATABLE":"false"
            },
            "x-queryable":true
        },
        "LinkId":{
            "type":"integer",
            "description":"Unique identifier used for the site link.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "PAYLOADHINT":"Show",
                "fnd:OA_TRANSLATABLE":"false"
            },
            "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."
        }
    }
}

Back to Top