Jump to

• Request
• Response

Update a calendar template

patch

/hcmRestApi/resources/11.13.18.05/wlfCalendarEventTemplates/{EventTemplateId}

Request

Path Parameters

• EventTemplateId(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

• TemplateBodyPlainString: string
  Maximum Length: 255

  Calendar event body in plain text.
• TemplateBodyRichString: string
  Maximum Length: 255

  Calendar event body in rich text.
• translations: array Calendar Template Translations
  Title: Calendar Template Translations

  The translations resource includes the translated values for calendar notifications sent to learners and instructors.

{
    "type":"object",
    "properties":{
        "TemplateBodyPlainString":{
            "maxLength":255,
            "type":"string",
            "description":"Calendar event body in plain text.",
            "nullable":true
        },
        "TemplateBodyRichString":{
            "maxLength":255,
            "type":"string",
            "description":"Calendar event body in rich text.",
            "nullable":true
        },
        "translations":{
            "title":"Calendar Template Translations",
            "type":"array",
            "description":"The translations resource includes the translated values for calendar notifications sent to learners and instructors.",
            "items":{
                "$ref":"#/components/schemas/wlfCalendarEventTemplates-translations-item-patch-request"
            }
        }
    }
}

Nested Schema : Calendar Template Translations

Type: array

Title: Calendar Template Translations

The translations resource includes the translated values for calendar notifications sent to learners and instructors.

Show Source

• Array of: object schema

{
    "title":"Calendar Template Translations",
    "type":"array",
    "description":"The translations resource includes the translated values for calendar notifications sent to learners and instructors.",
    "items":{
        "$ref":"#/components/schemas/wlfCalendarEventTemplates-translations-item-patch-request"
    }
}

Nested Schema : schema

Type: object

Show Source

• Language: string
  Maximum Length: 4

  Language the translated calendar template is in.
• SourceLang: string
  Maximum Length: 4

  Source language for the translated calendar template
• TemplateBodyPlainString: string
  Maximum Length: 255

  Translated calendar body string in plain text
• TemplateBodyRichString: string
  Maximum Length: 255

  Translated calendar body string in rich text

{
    "type":"object",
    "properties":{
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language the translated calendar template is in.",
            "nullable":false
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Source language for the translated calendar template",
            "nullable":false
        },
        "TemplateBodyPlainString":{
            "maxLength":255,
            "type":"string",
            "description":"Translated calendar body string in plain text",
            "nullable":true
        },
        "TemplateBodyRichString":{
            "maxLength":255,
            "type":"string",
            "description":"Translated calendar body string in rich text",
            "nullable":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 : wlfCalendarEventTemplates-item-response

Type: object

Show Source

• EventTemplateCode: string
  Maximum Length: 64

  Code that uniquely identifies the calendar template.
• EventTemplateId: integer (int64)
  Unique identifier for the calendar template.
• EventTemplateType: string
  Maximum Length: 64

  Type for the calendar event template, such as learner or instructor.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• TemplateBodyPlainString: string
  Maximum Length: 255

  Calendar event body in plain text.
• TemplateBodyRichString: string
  Maximum Length: 255

  Calendar event body in rich text.
• translations: array Calendar Template Translations
  Title: Calendar Template Translations

  The translations resource includes the translated values for calendar notifications sent to learners and instructors.

{
    "type":"object",
    "properties":{
        "EventTemplateCode":{
            "maxLength":64,
            "type":"string",
            "description":"Code that uniquely identifies the calendar template.",
            "nullable":false,
            "x-queryable":true
        },
        "EventTemplateId":{
            "type":"integer",
            "description":"Unique identifier for the calendar template.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EventTemplateType":{
            "maxLength":64,
            "type":"string",
            "description":"Type for the calendar event template, such as learner or instructor.",
            "nullable":false,
            "x-queryable":true
        },
        "TemplateBodyPlainString":{
            "maxLength":255,
            "type":"string",
            "description":"Calendar event body in plain text.",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateBodyRichString":{
            "maxLength":255,
            "type":"string",
            "description":"Calendar event body in rich text.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "translations":{
            "title":"Calendar Template Translations",
            "type":"array",
            "description":"The translations resource includes the translated values for calendar notifications sent to learners and instructors.",
            "items":{
                "$ref":"#/components/schemas/wlfCalendarEventTemplates-translations-item-response"
            }
        }
    }
}

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 : Calendar Template Translations

Type: array

Title: Calendar Template Translations

The translations resource includes the translated values for calendar notifications sent to learners and instructors.

Show Source

• Array of: object wlfCalendarEventTemplates-translations-item-response

{
    "title":"Calendar Template Translations",
    "type":"array",
    "description":"The translations resource includes the translated values for calendar notifications sent to learners and instructors.",
    "items":{
        "$ref":"#/components/schemas/wlfCalendarEventTemplates-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 : wlfCalendarEventTemplates-translations-item-response

Type: object

Show Source

• Language: string
  Maximum Length: 4

  Language the translated calendar template is in.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• SourceLang: string
  Maximum Length: 4

  Source language for the translated calendar template
• TemplateBodyPlainString: string
  Maximum Length: 255

  Translated calendar body string in plain text
• TemplateBodyRichString: string
  Maximum Length: 255

  Translated calendar body string in rich text

{
    "type":"object",
    "properties":{
        "Language":{
            "maxLength":4,
            "type":"string",
            "description":"Language the translated calendar template is in.",
            "nullable":false,
            "x-queryable":true
        },
        "SourceLang":{
            "maxLength":4,
            "type":"string",
            "description":"Source language for the translated calendar template",
            "nullable":false,
            "x-queryable":true
        },
        "TemplateBodyPlainString":{
            "maxLength":255,
            "type":"string",
            "description":"Translated calendar body string in plain text",
            "nullable":true,
            "x-queryable":true
        },
        "TemplateBodyRichString":{
            "maxLength":255,
            "type":"string",
            "description":"Translated calendar body string in rich text",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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

translations

Operation: /hcmRestApi/resources/11.13.18.05/wlfCalendarEventTemplates/{EventTemplateId}/child/translations

Parameters:

• EventTemplateId: $request.path.EventTemplateId

The translations resource includes the translated values for calendar notifications sent to learners and instructors.

Back to Top