Jump to

• Request
• Response

Update a celebrate program

patch

/hcmRestApi/resources/11.13.18.05/celebratePrograms/{CelebrateProgramId}

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=

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

• AllowVisibilityChangeFlag: boolean
  Maximum Length: 1
• AwardDescription: string
  Maximum Length: 300
• AwardTypeCode: string
  Maximum Length: 30
• Description: string
  Maximum Length: 300

  Description for the celebrate program.
• EndDate: string (date)
  End date for the celebrate program.
• NominationEndDate: string (date)
• OwnersEnabledFlag: boolean
  Maximum Length: 1
• PointsIncrement: number
• PointsMaximum: number
• PointsMinimum: number
• PointsRangeCode: string
  Maximum Length: 30
• programCards: array Quick Recognitions Template
  Title: Quick Recognitions Template

  The quick-recognition template for a celebrate program.
• programElements: array Program Elements
  Title: Program Elements

  The payroll elements related to the program.
• programEligibilities: array Program Eligibilities
  Title: Program Eligibilities

  The eligibility rules for the program.
• programIllustrations: array Program Images
  Title: Program Images

  The images for a celebrate program.
• ProgramName: string
  Maximum Length: 80

  Name for the celebrate program.
• programPanelMembers: array programPanelMembers
• programValues: array Program Values
  Title: Program Values

  The core values for a celebrate program.
• ReceiverListCode: string
  Maximum Length: 30
• SelectionEndDate: string (date)
• SenderLimitMaximum: integer (int64)
• StartDate: string (date)
  Start date for the celebrate program.
• SubtypeCode: string
  Maximum Length: 30
• TimeUnitCode: string
  Maximum Length: 30
• TimeUnitCount: integer (int64)
• TriggerTimeUnitCount: integer (int64)
• TypeCode: string
  Maximum Length: 30

  Type for the celebrate program.
• UsePointsFlag: boolean
  Maximum Length: 1

  Indicates whether the program uses points or not. Valid values are Y and N. Default value is Y.
• VisibilityCode: string
  Maximum Length: 30
• WinnersEnabledFlag: boolean
  Maximum Length: 1
• WinnersTotal: integer (int64)

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":300,
            "type":"string",
            "description":"Description for the celebrate program.",
            "nullable":true
        },
        "TriggerTimeUnitCount":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "programValues":{
            "title":"Program Values",
            "type":"array",
            "description":"The core values for a celebrate program.",
            "items":{
                "$ref":"#/components/schemas/celebratePrograms-programValues-item-patch-request"
            }
        },
        "TimeUnitCount":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "PointsRangeCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "PointsMaximum":{
            "type":"number",
            "nullable":true
        },
        "VisibilityCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date for the celebrate program.",
            "format":"date",
            "nullable":true
        },
        "AwardDescription":{
            "maxLength":300,
            "type":"string",
            "nullable":true
        },
        "SenderLimitMaximum":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AwardTypeCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "NominationEndDate":{
            "type":"string",
            "format":"date",
            "nullable":true
        },
        "ReceiverListCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "AllowVisibilityChangeFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true
        },
        "PointsMinimum":{
            "type":"number",
            "nullable":true
        },
        "WinnersTotal":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "programEligibilities":{
            "title":"Program Eligibilities",
            "type":"array",
            "description":"The eligibility rules for the program.",
            "items":{
                "$ref":"#/components/schemas/celebratePrograms-programEligibilities-item-patch-request"
            }
        },
        "TimeUnitCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "TypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type for the celebrate program.",
            "nullable":true
        },
        "PointsIncrement":{
            "type":"number",
            "nullable":true
        },
        "ProgramName":{
            "maxLength":80,
            "type":"string",
            "description":"Name for the celebrate program.",
            "nullable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date for the celebrate program.",
            "format":"date",
            "nullable":true
        },
        "programCards":{
            "title":"Quick Recognitions Template",
            "type":"array",
            "description":"The quick-recognition template for a celebrate program.",
            "items":{
                "$ref":"#/components/schemas/celebratePrograms-programCards-item-patch-request"
            },
            "x-cardinality":"1"
        },
        "programElements":{
            "title":"Program Elements",
            "type":"array",
            "description":"The payroll elements related to the program.",
            "items":{
                "$ref":"#/components/schemas/celebratePrograms-programElements-item-patch-request"
            }
        },
        "UsePointsFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the program uses points or not. Valid values are Y and N. Default value is Y.",
            "nullable":true
        },
        "programIllustrations":{
            "title":"Program Images",
            "type":"array",
            "description":"The images for a celebrate program.",
            "items":{
                "$ref":"#/components/schemas/celebratePrograms-programIllustrations-item-patch-request"
            }
        },
        "OwnersEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true
        },
        "WinnersEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true
        },
        "SubtypeCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true
        },
        "programPanelMembers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/celebratePrograms-programPanelMembers-item-patch-request"
            }
        },
        "SelectionEndDate":{
            "type":"string",
            "format":"date",
            "nullable":true
        }
    }
}

Nested Schema : Quick Recognitions Template

Type: array

Title: Quick Recognitions Template

The quick-recognition template for a celebrate program.

Show Source

• Array of: object celebratePrograms-programCards-item-patch-request

{
    "title":"Quick Recognitions Template",
    "type":"array",
    "description":"The quick-recognition template for a celebrate program.",
    "items":{
        "$ref":"#/components/schemas/celebratePrograms-programCards-item-patch-request"
    },
    "x-cardinality":"1"
}

Nested Schema : Program Elements

Type: array

Title: Program Elements

The payroll elements related to the program.

Show Source

• Array of: object celebratePrograms-programElements-item-patch-request

{
    "title":"Program Elements",
    "type":"array",
    "description":"The payroll elements related to the program.",
    "items":{
        "$ref":"#/components/schemas/celebratePrograms-programElements-item-patch-request"
    }
}

Nested Schema : Program Eligibilities

Type: array

Title: Program Eligibilities

The eligibility rules for the program.

Show Source

• Array of: object celebratePrograms-programEligibilities-item-patch-request

{
    "title":"Program Eligibilities",
    "type":"array",
    "description":"The eligibility rules for the program.",
    "items":{
        "$ref":"#/components/schemas/celebratePrograms-programEligibilities-item-patch-request"
    }
}

Nested Schema : Program Images

Type: array

Title: Program Images

The images for a celebrate program.

Show Source

• Array of: object celebratePrograms-programIllustrations-item-patch-request

{
    "title":"Program Images",
    "type":"array",
    "description":"The images for a celebrate program.",
    "items":{
        "$ref":"#/components/schemas/celebratePrograms-programIllustrations-item-patch-request"
    }
}

Nested Schema : programPanelMembers

Type: array

Show Source

• Array of: object celebratePrograms-programPanelMembers-item-patch-request

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/celebratePrograms-programPanelMembers-item-patch-request"
    }
}

Nested Schema : Program Values

Type: array

Title: Program Values

The core values for a celebrate program.

Show Source

• Array of: object schema

{
    "title":"Program Values",
    "type":"array",
    "description":"The core values for a celebrate program.",
    "items":{
        "$ref":"#/components/schemas/celebratePrograms-programValues-item-patch-request"
    }
}

Nested Schema : celebratePrograms-programCards-item-patch-request

Type: object

Show Source

• CardHeadline: string
  Maximum Length: 80

  Finds all program images that match the specified criteria.
• CardMessage: string
  Maximum Length: 2000

  Default message in the program image.
• CelebrateProgramId: integer (int64)
  Unique identifier of the program.
• IllustrationId: integer (int64)
  Unique identifier of the program image.
• Points: number
  Default number of points.
• ValueId: integer (int64)
  Unique identifier of the core value.

{
    "type":"object",
    "properties":{
        "Points":{
            "type":"number",
            "description":"Default number of points.",
            "nullable":true
        },
        "CelebrateProgramId":{
            "type":"integer",
            "description":"Unique identifier of the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "IllustrationId":{
            "type":"integer",
            "description":"Unique identifier of the program image.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CardMessage":{
            "maxLength":2000,
            "type":"string",
            "description":"Default message in the program image.",
            "nullable":true
        },
        "ValueId":{
            "type":"integer",
            "description":"Unique identifier of the core value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "CardHeadline":{
            "maxLength":80,
            "type":"string",
            "description":"Finds all program images that match the specified criteria.",
            "nullable":true
        }
    }
}

Nested Schema : celebratePrograms-programElements-item-patch-request

Type: object

Show Source

• ElementTypeId: integer (int64)
  Unique identifier of the element type.
• InputCurrencyCode: string
  Maximum Length: 15

  Unique identifier of the celebrate program.
• InputValueId: integer (int64)
  Unique identifier of the celebrate program.
• LegalEntityId: integer (int64)
  Unique identifier of the legal entity.
• LegislationCode: string
  Maximum Length: 30

  Legislation code.
• LegislativeDataGroupId: integer (int64)
  Unique identifier of the legislative data group.

{
    "type":"object",
    "properties":{
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Unique identifier of the legislative data group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "LegislationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Legislation code.",
            "nullable":true
        },
        "LegalEntityId":{
            "type":"integer",
            "description":"Unique identifier of the legal entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InputValueId":{
            "type":"integer",
            "description":"Unique identifier of the celebrate program.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ElementTypeId":{
            "type":"integer",
            "description":"Unique identifier of the element type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "InputCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Unique identifier of the celebrate program.",
            "nullable":true
        }
    }
}

Nested Schema : celebratePrograms-programEligibilities-item-patch-request

Type: object

Show Source

• CelebrateProgramId: integer (int64)
  Unique identifier of the program.
• EligibilityProfileId: integer (int64)
  Unique identifier of the eligibility profile.
• RequiredFlag: boolean
  Maximum Length: 1

  Indicates whether the eligibility rule is required. Valid values are true and false.

{
    "type":"object",
    "properties":{
        "RequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the eligibility rule is required. Valid values are true and false.",
            "nullable":true
        },
        "CelebrateProgramId":{
            "type":"integer",
            "description":"Unique identifier of the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "EligibilityProfileId":{
            "type":"integer",
            "description":"Unique identifier of the eligibility profile.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

Nested Schema : celebratePrograms-programIllustrations-item-patch-request

Type: object

Show Source

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

Nested Schema : celebratePrograms-programPanelMembers-item-patch-request

Type: object

Show Source

• AssignmentId: integer (int64)
• CelebrateProgramId: integer (int64)
• PersonId: integer (int64)
• SelectorFlag: boolean
  Maximum Length: 1

{
    "type":"object",
    "properties":{
        "AssignmentId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "CelebrateProgramId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PersonId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "SelectorFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":false
        }
    }
}

Nested 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-item-response

Type: object

Show Source

• AllowVisibilityChangeFlag: boolean
  Maximum Length: 1
• AwardDescription: string
  Maximum Length: 300
• AwardTypeCode: string
  Maximum Length: 30
• CelebrateProgramId: integer (int64)
  Unique identifier of the celebrate program.
• Description: string
  Maximum Length: 300

  Description for the celebrate program.
• EndDate: string (date)
  End date for the celebrate program.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NominationEndDate: string (date)
• OwnersEnabledFlag: boolean
  Maximum Length: 1
• PointsIncrement: number
• PointsMaximum: number
• PointsMinimum: number
• PointsRangeCode: string
  Maximum Length: 30
• programCards: array Quick Recognitions Template
  Title: Quick Recognitions Template

  The quick-recognition template for a celebrate program.
• programElements: array Program Elements
  Title: Program Elements

  The payroll elements related to the program.
• programEligibilities: array Program Eligibilities
  Title: Program Eligibilities

  The eligibility rules for the program.
• programIllustrations: array Program Images
  Title: Program Images

  The images for a celebrate program.
• ProgramName: string
  Maximum Length: 80

  Name for the celebrate program.
• programPanelMembers: array programPanelMembers
• programValues: array Program Values
  Title: Program Values

  The core values for a celebrate program.
• ReceiverListCode: string
  Maximum Length: 30
• SelectionEndDate: string (date)
• SenderLimitMaximum: integer (int64)
• StartDate: string (date)
  Start date for the celebrate program.
• SubtypeCode: string
  Maximum Length: 30
• TimeUnitCode: string
  Maximum Length: 30
• TimeUnitCount: integer (int64)
• TriggerTimeUnitCount: integer (int64)
• TypeCode: string
  Maximum Length: 30

  Type for the celebrate program.
• UsePointsFlag: boolean
  Maximum Length: 1

  Indicates whether the program uses points or not. Valid values are Y and N. Default value is Y.
• VisibilityCode: string
  Maximum Length: 30
• WinnersEnabledFlag: boolean
  Maximum Length: 1
• WinnersTotal: integer (int64)

{
    "type":"object",
    "properties":{
        "Description":{
            "maxLength":300,
            "type":"string",
            "description":"Description for the celebrate program.",
            "nullable":true,
            "x-queryable":true
        },
        "TriggerTimeUnitCount":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "programValues":{
            "title":"Program Values",
            "type":"array",
            "description":"The core values for a celebrate program.",
            "items":{
                "$ref":"#/components/schemas/celebratePrograms-programValues-item-response"
            }
        },
        "TimeUnitCount":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PointsRangeCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "PointsMaximum":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "VisibilityCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "StartDate":{
            "type":"string",
            "description":"Start date for the celebrate program.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "AwardDescription":{
            "maxLength":300,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "SenderLimitMaximum":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AwardTypeCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "NominationEndDate":{
            "type":"string",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "ReceiverListCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "AllowVisibilityChangeFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "x-queryable":true
        },
        "PointsMinimum":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "WinnersTotal":{
            "type":"integer",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "programEligibilities":{
            "title":"Program Eligibilities",
            "type":"array",
            "description":"The eligibility rules for the program.",
            "items":{
                "$ref":"#/components/schemas/celebratePrograms-programEligibilities-item-response"
            }
        },
        "TimeUnitCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "TypeCode":{
            "maxLength":30,
            "type":"string",
            "description":"Type for the celebrate program.",
            "nullable":true,
            "x-queryable":true
        },
        "PointsIncrement":{
            "type":"number",
            "nullable":true,
            "x-queryable":true
        },
        "ProgramName":{
            "maxLength":80,
            "type":"string",
            "description":"Name for the celebrate program.",
            "nullable":true,
            "x-queryable":true
        },
        "EndDate":{
            "type":"string",
            "description":"End date for the celebrate program.",
            "format":"date",
            "nullable":true,
            "x-queryable":true
        },
        "programCards":{
            "title":"Quick Recognitions Template",
            "type":"array",
            "description":"The quick-recognition template for a celebrate program.",
            "items":{
                "$ref":"#/components/schemas/celebratePrograms-programCards-item-response"
            },
            "x-cardinality":"1"
        },
        "programElements":{
            "title":"Program Elements",
            "type":"array",
            "description":"The payroll elements related to the program.",
            "items":{
                "$ref":"#/components/schemas/celebratePrograms-programElements-item-response"
            }
        },
        "UsePointsFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the program uses points or not. Valid values are Y and N. Default value is Y.",
            "nullable":true,
            "x-queryable":true
        },
        "programIllustrations":{
            "title":"Program Images",
            "type":"array",
            "description":"The images for a celebrate program.",
            "items":{
                "$ref":"#/components/schemas/celebratePrograms-programIllustrations-item-response"
            }
        },
        "CelebrateProgramId":{
            "type":"integer",
            "description":"Unique identifier of the celebrate program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OwnersEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "x-queryable":true
        },
        "WinnersEnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":true,
            "x-queryable":true
        },
        "SubtypeCode":{
            "maxLength":30,
            "type":"string",
            "nullable":true,
            "x-queryable":true
        },
        "programPanelMembers":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/celebratePrograms-programPanelMembers-item-response"
            }
        },
        "SelectionEndDate":{
            "type":"string",
            "format":"date",
            "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 : Quick Recognitions Template

Type: array

Title: Quick Recognitions Template

The quick-recognition template for a celebrate program.

Show Source

• Array of: object celebratePrograms-programCards-item-response

{
    "title":"Quick Recognitions Template",
    "type":"array",
    "description":"The quick-recognition template for a celebrate program.",
    "items":{
        "$ref":"#/components/schemas/celebratePrograms-programCards-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Program Elements

Type: array

Title: Program Elements

The payroll elements related to the program.

Show Source

• Array of: object celebratePrograms-programElements-item-response

{
    "title":"Program Elements",
    "type":"array",
    "description":"The payroll elements related to the program.",
    "items":{
        "$ref":"#/components/schemas/celebratePrograms-programElements-item-response"
    }
}

Nested Schema : Program Eligibilities

Type: array

Title: Program Eligibilities

The eligibility rules for the program.

Show Source

• Array of: object celebratePrograms-programEligibilities-item-response

{
    "title":"Program Eligibilities",
    "type":"array",
    "description":"The eligibility rules for the program.",
    "items":{
        "$ref":"#/components/schemas/celebratePrograms-programEligibilities-item-response"
    }
}

Nested Schema : Program Images

Type: array

Title: Program Images

The images for a celebrate program.

Show Source

• Array of: object celebratePrograms-programIllustrations-item-response

{
    "title":"Program Images",
    "type":"array",
    "description":"The images for a celebrate program.",
    "items":{
        "$ref":"#/components/schemas/celebratePrograms-programIllustrations-item-response"
    }
}

Nested Schema : programPanelMembers

Type: array

Show Source

• Array of: object celebratePrograms-programPanelMembers-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/celebratePrograms-programPanelMembers-item-response"
    }
}

Nested Schema : Program Values

Type: array

Title: Program Values

The core values for a celebrate program.

Show Source

• Array of: object celebratePrograms-programValues-item-response

{
    "title":"Program Values",
    "type":"array",
    "description":"The core values for a celebrate program.",
    "items":{
        "$ref":"#/components/schemas/celebratePrograms-programValues-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 : celebratePrograms-programCards-item-response

Type: object

Show Source

• CardHeadline: string
  Maximum Length: 80

  Finds all program images that match the specified criteria.
• CardId: integer (int64)
  Unique identifier of the program image.
• CardMessage: string
  Maximum Length: 2000

  Default message in the program image.
• CelebrateProgramId: integer (int64)
  Unique identifier of the program.
• Description: string
  Read Only: true

  Maximum Length: 240

  Description 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.
• Points: number
  Default number of points.
• ValueId: integer (int64)
  Unique identifier of the core value.
• ValueName: string
  Read Only: true

  Maximum Length: 80

  Name of the core value.

{
    "type":"object",
    "properties":{
        "Points":{
            "type":"number",
            "description":"Default number of points.",
            "nullable":true,
            "x-queryable":true
        },
        "Description":{
            "maxLength":240,
            "type":"string",
            "description":"Description of the program image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CelebrateProgramId":{
            "type":"integer",
            "description":"Unique identifier of the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IllustrationId":{
            "type":"integer",
            "description":"Unique identifier of the program image.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CardMessage":{
            "maxLength":2000,
            "type":"string",
            "description":"Default message in the program image.",
            "nullable":true,
            "x-queryable":true
        },
        "ValueName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the core value.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ValueId":{
            "type":"integer",
            "description":"Unique identifier of the core value.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "IllustrationName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the program image.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CardId":{
            "type":"integer",
            "description":"Unique identifier of the program image.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CardHeadline":{
            "maxLength":80,
            "type":"string",
            "description":"Finds all program images that match the specified criteria.",
            "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 : celebratePrograms-programElements-item-response

Type: object

Show Source

• CelebrateProgramId: integer (int64)
  Unique identifier of the celebrate program.
• ElementTypeId: integer (int64)
  Unique identifier of the element type.
• InputCurrencyCode: string
  Maximum Length: 15

  Unique identifier of the celebrate program.
• InputValueId: integer (int64)
  Unique identifier of the celebrate program.
• LegalEntityId: integer (int64)
  Unique identifier of the legal entity.
• LegislationCode: string
  Maximum Length: 30

  Legislation code.
• LegislativeDataGroupId: integer (int64)
  Unique identifier of the legislative data group.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProgramElementId: integer (int64)
  Unique identifier of the payroll element of the program.

{
    "type":"object",
    "properties":{
        "LegislativeDataGroupId":{
            "type":"integer",
            "description":"Unique identifier of the legislative data group.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CelebrateProgramId":{
            "type":"integer",
            "description":"Unique identifier of the celebrate program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LegislationCode":{
            "maxLength":30,
            "type":"string",
            "description":"Legislation code.",
            "nullable":true,
            "x-queryable":true
        },
        "LegalEntityId":{
            "type":"integer",
            "description":"Unique identifier of the legal entity.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InputValueId":{
            "type":"integer",
            "description":"Unique identifier of the celebrate program.",
            "format":"int64",
            "nullable":true,
            "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"
            }
        },
        "ElementTypeId":{
            "type":"integer",
            "description":"Unique identifier of the element type.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramElementId":{
            "type":"integer",
            "description":"Unique identifier of the payroll element of the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "InputCurrencyCode":{
            "maxLength":15,
            "type":"string",
            "description":"Unique identifier of the celebrate program.",
            "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 : celebratePrograms-programEligibilities-item-response

Type: object

Show Source

• CelebrateProgramId: integer (int64)
  Unique identifier of the program.
• EligibilityProfileId: integer (int64)
  Unique identifier of the eligibility profile.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ProgramEligibilityId: integer (int64)
  Unique identifier of the eligibility.
• RequiredFlag: boolean
  Maximum Length: 1

  Indicates whether the eligibility rule is required. Valid values are true and false.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RequiredFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the eligibility rule is required. Valid values are true and false.",
            "nullable":true,
            "x-queryable":true
        },
        "CelebrateProgramId":{
            "type":"integer",
            "description":"Unique identifier of the program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ProgramEligibilityId":{
            "type":"integer",
            "description":"Unique identifier of the eligibility.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EligibilityProfileId":{
            "type":"integer",
            "description":"Unique identifier of the eligibility profile.",
            "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"
    }
}

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

Type: object

Show Source

• AssignmentId: integer (int64)
• AssignmentName: string
  Title: Assignment Name

  Read Only: true

  Maximum Length: 80
• CelebrateProgramId: integer (int64)
• EmailAddress: string
  Title: Email

  Read Only: true

  Maximum Length: 240
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• PersonId: integer (int64)
• PersonName: string
  Title: Name

  Read Only: true

  Maximum Length: 240
• ProgramPanelMemberId: integer (int64)
• SelectorFlag: boolean
  Maximum Length: 1

{
    "type":"object",
    "properties":{
        "PersonName":{
            "title":"Name",
            "maxLength":240,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProgramPanelMemberId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CelebrateProgramId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AssignmentName":{
            "title":"Assignment Name",
            "maxLength":80,
            "type":"string",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AssignmentId":{
            "type":"integer",
            "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"
            }
        },
        "SelectorFlag":{
            "maxLength":1,
            "type":"boolean",
            "nullable":false,
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Email",
            "maxLength":240,
            "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 : celebratePrograms-programValues-item-response

Type: object

Show Source

• CelebrateProgramId: integer (int64)
  Unique identifier of the celebrate program.
• EnabledFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates whether core values are used or not in Celebrate. Valid values are Y and N. Default value is Y.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• ValueId: string
  Maximum Length: 18

  Unique identifier of the core value.
• ValueName: string
  Read Only: true

  Maximum Length: 80

  Name of the core value.

{
    "type":"object",
    "properties":{
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ValueId":{
            "maxLength":18,
            "type":"string",
            "description":"Unique identifier of the core value.",
            "nullable":false,
            "x-queryable":true
        },
        "CelebrateProgramId":{
            "type":"integer",
            "description":"Unique identifier of the celebrate program.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether core values are used or not in Celebrate. Valid values are Y and N. Default value is Y.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ValueName":{
            "maxLength":80,
            "type":"string",
            "description":"Name of the core value.",
            "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"
    }
}

Links

programCards

Operation: /hcmRestApi/resources/11.13.18.05/celebratePrograms/{CelebrateProgramId}/child/programCards

Parameters:

• CelebrateProgramId: $request.path.CelebrateProgramId

The quick-recognition template for a celebrate program.

programElements

Operation: /hcmRestApi/resources/11.13.18.05/celebratePrograms/{CelebrateProgramId}/child/programElements

Parameters:

• CelebrateProgramId: $request.path.CelebrateProgramId

The payroll elements related to the program.

programEligibilities

Operation: /hcmRestApi/resources/11.13.18.05/celebratePrograms/{CelebrateProgramId}/child/programEligibilities

Parameters:

• CelebrateProgramId: $request.path.CelebrateProgramId

The eligibility rules for the program.

programIllustrations

Operation: /hcmRestApi/resources/11.13.18.05/celebratePrograms/{CelebrateProgramId}/child/programIllustrations

Parameters:

• CelebrateProgramId: $request.path.CelebrateProgramId

The images for a celebrate program.

programPanelMembers

Operation: /hcmRestApi/resources/11.13.18.05/celebratePrograms/{CelebrateProgramId}/child/programPanelMembers

Parameters:

• CelebrateProgramId: $request.path.CelebrateProgramId

programValues

Operation: /hcmRestApi/resources/11.13.18.05/celebratePrograms/{CelebrateProgramId}/child/programValues

Parameters:

• CelebrateProgramId: $request.path.CelebrateProgramId

The core values for a celebrate program.

Back to Top