Jump to

• Request
• Response

Update a box label

patch

/hcmRestApi/resources/11.13.18.05/talentReviewMeetingTemplates/{talentReviewMeetingTemplatesUniqID}/child/analyticTypes/{analyticTypesUniqID}/child/boxLabels/{boxLabelsUniqID}

Request

Path Parameters

• analyticTypesUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AnalyticTypeId and BusinessGroupId ---for the Analytic Types resource and used to uniquely identify an instance of Analytic Types. The client should not generate the hash key value. Instead, the client should query on the Analytic Types collection resource with a filter on the primary key values in order to navigate to a specific instance of Analytic Types.
  
  For example: analyticTypes?q=AnalyticTypeId=<value1>;BusinessGroupId=<value2>
• boxLabelsUniqID(required): string
  This is the hash key of the attributes which make up the composite key--- AnalyticBoxLabelId and BusinessGroupId ---for the Box Labels resource and used to uniquely identify an instance of Box Labels. The client should not generate the hash key value. Instead, the client should query on the Box Labels collection resource with a filter on the primary key values in order to navigate to a specific instance of Box Labels.
  
  For example: boxLabels?q=AnalyticBoxLabelId=<value1>;BusinessGroupId=<value2>
• talentReviewMeetingTemplatesUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Talent Review Meeting Templates resource and used to uniquely identify an instance of Talent Review Meeting Templates. The client should not generate the hash key value. Instead, the client should query on the Talent Review Meeting Templates collection resource in order to navigate to a specific instance of Talent Review Meeting Templates to get the hash key.

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

• BoxcellBackgroundColor: string
  Maximum Length: 2000

  Background color for the box of the box chart.
• BoxLabel: string
  Maximum Length: 400

  Label for the box of the box chart.
• BoxSequence: integer (int64)
  Sequence for the box of the box chart.
• DisplaySequence: integer
  Display sequence for the box cell label.

{
    "type":"object",
    "properties":{
        "BoxSequence":{
            "type":"integer",
            "description":"Sequence for the box of the box chart.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "BoxcellBackgroundColor":{
            "maxLength":2000,
            "type":"string",
            "description":"Background color for the box of the box chart.",
            "nullable":true
        },
        "BoxLabel":{
            "maxLength":400,
            "type":"string",
            "description":"Label for the box of the box chart.",
            "nullable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"Display sequence for the box cell label.",
            "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 : talentReviewMeetingTemplates-analyticTypes-boxLabels-item-response

Type: object

Show Source

• AnalyticBoxLabelId: integer (int64)
  Unique identifier for the box label.
• BoxcellBackgroundColor: string
  Maximum Length: 2000

  Background color for the box of the box chart.
• BoxLabel: string
  Maximum Length: 400

  Label for the box of the box chart.
• BoxSequence: integer (int64)
  Sequence for the box of the box chart.
• BusinessGroupId: integer (int64)
  Unique identifier for the business group for which the box cell labels will be used.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the box cell label.
• CreationDate: string (date-time)
  Read Only: true

  Date the box cell label was created.
• DisplaySequence: integer
  Display sequence for the box cell label.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date the box cell label was last updated.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who last updated the box cell label.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who last updated the box cell label.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Date the box cell label was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BoxSequence":{
            "type":"integer",
            "description":"Sequence for the box of the box chart.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BoxcellBackgroundColor":{
            "maxLength":2000,
            "type":"string",
            "description":"Background color for the box of the box chart.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the box cell label.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DisplaySequence":{
            "type":"integer",
            "description":"Display sequence for the box cell label.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AnalyticBoxLabelId":{
            "type":"integer",
            "description":"Unique identifier for the box label.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BusinessGroupId":{
            "type":"integer",
            "description":"Unique identifier for the business group for which the box cell labels will be used.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "BoxLabel":{
            "maxLength":400,
            "type":"string",
            "description":"Label for the box of the box chart.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date the box cell label was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":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 : 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