Jump to

• Request
• Response

Update a program image for celebrate

patch

/hcmRestApi/resources/11.13.18.05/celebratePrograms/{CelebrateProgramId}/child/programIllustrations/{programIllustrationsUniqID}

Request

Path Parameters

• CelebrateProgramId(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=
• programIllustrationsUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Program Images resource and used to uniquely identify an instance of Program Images. The client should not generate the hash key value. Instead, the client should query on the Program Images collection resource in order to navigate to a specific instance of Program Images 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

{
    "type":"object",
    "properties":{
    }
}

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 : celebratePrograms-programIllustrations-item-response

Type: object

Show Source

• CelebrateIllustrationURL: string
  Read Only: true

  Maximum Length: 4000
• CelebrateProgramId: integer (int64)
  Unique identifier of the celebrate program.
• Description: string
  Read Only: true

  Maximum Length: 240

  Description for the program image.
• EnabledFlag: boolean
  Read Only: true

  Maximum Length: 1

  Flag to enable the program image.
• Illustration: string (byte)
  Read Only: true

  Actual image for the program image.
• IllustrationCode: string
  Read Only: true

  Maximum Length: 30

  Code of the program image.
• IllustrationId: integer (int64)
  Unique identifier of the program image.
• IllustrationName: string
  Read Only: true

  Maximum Length: 80

  Name of the program image.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description for the program image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CelebrateProgramId":{
            "type":"integer",
            "description":"Unique identifier of the celebrate program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Illustration":{
            "type":"string",
            "description":"Actual image for the program image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "IllustrationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Code of the program image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "IllustrationId":{
            "type":"integer",
            "description":"Unique identifier of the program image.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "IllustrationName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the program image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Flag to enable the program image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CelebrateIllustrationURL":{
            "maxLength":4000,
            "type":"string",
            "nullable":true,
            "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