workday-connect

Workday Connect - message templates, notification types, send messages

Server path: /workday-connect | Type: Application | PCID required: Yes

Tools

Tool	Description
workday_connect_get_messagetemplates	Retrieves a collection of message templates.
workday_connect_get_messagetemplates_by_id	Retrieves a message template with the specific ID.
workday_connect_get_notificationtypes	Retrieves a collection of notification types.
workday_connect_get_notificationtypes_by_id	Retrieves a notification type.
workday_connect_get_values_audiencepromptgroup_audiencetype	Retrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Administer Audience, Administer Campaigns <b>Scope:</b> Learning Core, System
workday_connect_get_values_audiencepromptgroup_selection	Retrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Administer Audience, Administer Campaigns <b>Scope:</b> Learning Core, System
workday_connect_patch_messagetemplates_by_id	Partially updates an existing message template instance.
workday_connect_post_messagetemplates	<b>Secured by:</b> Set Up: Message Templates <b>Scope:</b> Learning Core, System
workday_connect_post_sendmessage	sendMessage API
workday_connect_put_messagetemplates_by_id	Updates an existing message template instance.

---

workday_connect_get_messagetemplates

Retrieves a collection of message templates.

Parameters:

Parameter	Type	Required	Default	Description
inactive	boolean	No	—	The inactive value
limit	integer	No	—	The maximum number of objects in a single response. The default is 20. The maximum is 100.
name	string	No	—	The name value
notificationType	string	No	—	Notification Type
offset	integer	No	—	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "inactive": {
      "type": "boolean",
      "description": "The inactive value"
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
    },
    "name": {
      "type": "string",
      "description": "The name value"
    },
    "notificationType": {
      "type": "string",
      "description": "Notification Type"
    },
    "offset": {
      "type": "integer",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object."
    }
  },
  "required": [
    "PCID"
  ]
}

---

workday_connect_get_messagetemplates_by_id

Retrieves a message template with the specific ID.

Parameters:

Parameter	Type	Required	Default	Description
ID	string	Yes	—	The Workday ID of the resource.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

---

workday_connect_get_notificationtypes

Retrieves a collection of notification types.

Parameters:

Parameter	Type	Required	Default	Description
limit	integer	No	—	The maximum number of objects in a single response. The default is 20. The maximum is 100.
offset	integer	No	—	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of objects in a single response. The default is 20. The maximum is 100."
    },
    "offset": {
      "type": "integer",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object."
    }
  },
  "required": [
    "PCID"
  ]
}

---

workday_connect_get_notificationtypes_by_id

Retrieves a notification type.

Parameters:

Parameter	Type	Required	Default	Description
ID	string	Yes	—	The Workday ID of the resource.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    }
  },
  "required": [
    "PCID",
    "ID"
  ]
}

---

workday_connect_get_values_audiencepromptgroup_audiencetype

Retrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Administer Audience, Administer Campaigns <b>Scope:</b> Learning Core, System

Parameters:

Parameter	Type	Required	Default	Description
audienceTypeParm	string	No	—	Audience Type Parm
connectType	string	No	—	Connect Type
limit	integer	No	—	The maximum number of objects in a single response. The default and maximum is 1000.
offset	integer	No	—	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
search	string	No	—	A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "audienceTypeParm": {
      "type": "string",
      "description": "Audience Type Parm"
    },
    "connectType": {
      "type": "string",
      "description": "Connect Type"
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of objects in a single response. The default and maximum is 1000."
    },
    "offset": {
      "type": "integer",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object."
    },
    "search": {
      "type": "string",
      "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string."
    }
  },
  "required": [
    "PCID"
  ]
}

---

workday_connect_get_values_audiencepromptgroup_selection

Retrieves instances that can be used as values for other endpoint parameters in this service. <b>Secured by:</b> Administer Audience, Administer Campaigns <b>Scope:</b> Learning Core, System

Parameters:

Parameter	Type	Required	Default	Description
audienceTypeParm	string	No	—	Audience Type Parm
connectType	string	No	—	Connect Type
limit	integer	No	—	The maximum number of objects in a single response. The default and maximum is 1000.
offset	integer	No	—	The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object.
search	string	No	—	A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "audienceTypeParm": {
      "type": "string",
      "description": "Audience Type Parm"
    },
    "connectType": {
      "type": "string",
      "description": "Connect Type"
    },
    "limit": {
      "type": "integer",
      "description": "The maximum number of objects in a single response. The default and maximum is 1000."
    },
    "offset": {
      "type": "integer",
      "description": "The zero-based index of the first object in a response collection. The default is 0. Use offset with the limit parameter to control paging of a response collection. Example: If limit is 5 and offset is 9, the response returns a collection of 5 objects starting with the 10th object."
    },
    "search": {
      "type": "string",
      "description": "A search string that matches display IDs. The search is case-insensitive and matches words that start with the given string."
    }
  },
  "required": [
    "PCID"
  ]
}

---

workday_connect_patch_messagetemplates_by_id

Partially updates an existing message template instance.

Parameters:

Parameter	Type	Required	Default	Description
ID	string	Yes	—	The Workday ID of the resource.
createdBy	object	No	—	Message Template creator.
createdOn	string	No	—	Gives the date that the instance was originally created.
descriptor	string	No	—	The display name of the instance
emailDetail	object	No	—	Email Configuration container for REST API.
id	string	No	—	Workday Id or Reference Id of the instance.
inactive	boolean	No	—	Indicates template is active or has been disabled.
lastUpdated	string	No	—	Last Updated
lastUpdatedBy	object	No	—	Person who last updated the instance.
name	string	Yes	—	Message Template Name
notificationType	object	Yes	—	Notification Type indicates where the template can be used.
pushDetail	object	No	—	Container for push notification data, used in REST API.
referenceID	string	No	—	The Reference ID to use for lookups within our Workday Web Services. For ~supervisory organizations~, this is also the ‘Organization ID’
usageCount	integer	No	—	Count of instances using this Message Template

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    },
    "createdBy": {
      "description": "Message Template creator."
    },
    "createdOn": {
      "type": "string",
      "description": "Gives the date that the instance was originally created."
    },
    "descriptor": {
      "type": "string",
      "description": "The display name of the instance"
    },
    "emailDetail": {
      "description": "Email Configuration container for REST API."
    },
    "id": {
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    },
    "inactive": {
      "type": "boolean",
      "description": "Indicates template is active or has been disabled."
    },
    "lastUpdated": {
      "type": "string",
      "description": "Last Updated"
    },
    "lastUpdatedBy": {
      "description": "Person who last updated the instance."
    },
    "name": {
      "type": "string",
      "description": "Message Template Name"
    },
    "notificationType": {
      "description": "Notification Type indicates where the template can be used."
    },
    "pushDetail": {
      "description": "Container for push notification data, used in REST API."
    },
    "referenceID": {
      "type": "string",
      "description": "The Reference ID to use for lookups within our Workday Web Services. For \\~supervisory organizations\\~, this is also the 'Organization ID'"
    },
    "usageCount": {
      "type": "integer",
      "description": "Count of instances using this Message Template"
    }
  },
  "required": [
    "PCID",
    "ID",
    "name",
    "notificationType"
  ]
}

---

workday_connect_post_messagetemplates

<b>Secured by:</b> Set Up: Message Templates <b>Scope:</b> Learning Core, System

Parameters:

Parameter	Type	Required	Default	Description
createdBy	object	No	—	Message Template creator.
createdOn	string	No	—	Gives the date that the instance was originally created.
descriptor	string	No	—	The display name of the instance
emailDetail	object	No	—	Email Configuration container for REST API.
id	string	No	—	Workday Id or Reference Id of the instance.
inactive	boolean	No	—	Indicates template is active or has been disabled.
lastUpdated	string	No	—	Last Updated
lastUpdatedBy	object	No	—	Person who last updated the instance.
name	string	Yes	—	Message Template Name
notificationType	object	Yes	—	Notification Type indicates where the template can be used.
pushDetail	object	No	—	Container for push notification data, used in REST API.
referenceID	string	No	—	The Reference ID to use for lookups within our Workday Web Services. For ~supervisory organizations~, this is also the ‘Organization ID’
usageCount	integer	No	—	Count of instances using this Message Template

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "createdBy": {
      "description": "Message Template creator."
    },
    "createdOn": {
      "type": "string",
      "description": "Gives the date that the instance was originally created."
    },
    "descriptor": {
      "type": "string",
      "description": "The display name of the instance"
    },
    "emailDetail": {
      "description": "Email Configuration container for REST API."
    },
    "id": {
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    },
    "inactive": {
      "type": "boolean",
      "description": "Indicates template is active or has been disabled."
    },
    "lastUpdated": {
      "type": "string",
      "description": "Last Updated"
    },
    "lastUpdatedBy": {
      "description": "Person who last updated the instance."
    },
    "name": {
      "type": "string",
      "description": "Message Template Name"
    },
    "notificationType": {
      "description": "Notification Type indicates where the template can be used."
    },
    "pushDetail": {
      "description": "Container for push notification data, used in REST API."
    },
    "referenceID": {
      "type": "string",
      "description": "The Reference ID to use for lookups within our Workday Web Services. For \\~supervisory organizations\\~, this is also the 'Organization ID'"
    },
    "usageCount": {
      "type": "integer",
      "description": "Count of instances using this Message Template"
    }
  },
  "required": [
    "PCID",
    "name",
    "notificationType"
  ]
}

---

workday_connect_post_sendmessage

sendMessage API

Parameters:

Parameter	Type	Required	Default	Description
commID	object	No	—	Group Communication
emailDetail	object	No	—	Email Configuration Data
messageTemplate	object	No	—	Message Template used by Ad-hoc/Group Communications
notificationType	object	No	—	Notification Type indicates where the template can be used.
pushDetail	object	No	—	Container for push notification data, used in REST API
recipients	object	No	—	This field is just used by REST framework to provide a container, there is no real data behind it.
senderOverride	object	No	—	This field affects the sender icon that will be displayed in the Workday Inbox.

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "commID": {
      "description": "Group Communication"
    },
    "emailDetail": {
      "description": "Email Configuration Data"
    },
    "messageTemplate": {
      "description": "Message Template used by Ad-hoc/Group Communications"
    },
    "notificationType": {
      "description": "Notification Type indicates where the template can be used."
    },
    "pushDetail": {
      "description": "Container for push notification data, used in REST API"
    },
    "recipients": {
      "description": "This field is just used by REST framework to provide a container, there is no real data behind it."
    },
    "senderOverride": {
      "description": "This field affects the sender icon that will be displayed in the Workday Inbox."
    }
  },
  "required": [
    "PCID"
  ]
}

---

workday_connect_put_messagetemplates_by_id

Updates an existing message template instance.

Parameters:

Parameter	Type	Required	Default	Description
ID	string	Yes	—	The Workday ID of the resource.
createdBy	object	No	—	Message Template creator.
createdOn	string	No	—	Gives the date that the instance was originally created.
descriptor	string	No	—	The display name of the instance
emailDetail	object	No	—	Email Configuration container for REST API.
id	string	No	—	Workday Id or Reference Id of the instance.
inactive	boolean	No	—	Indicates template is active or has been disabled.
lastUpdated	string	No	—	Last Updated
lastUpdatedBy	object	No	—	Person who last updated the instance.
name	string	Yes	—	Message Template Name
notificationType	object	Yes	—	Notification Type indicates where the template can be used.
pushDetail	object	No	—	Container for push notification data, used in REST API.
referenceID	string	No	—	The Reference ID to use for lookups within our Workday Web Services. For ~supervisory organizations~, this is also the ‘Organization ID’
usageCount	integer	No	—	Count of instances using this Message Template

Show inputSchema

{
  "type": "object",
  "properties": {
    "PCID": {
      "type": "string",
      "description": "Pink Connect ID for the authenticated connection"
    },
    "ID": {
      "type": "string",
      "description": "The Workday ID of the resource."
    },
    "createdBy": {
      "description": "Message Template creator."
    },
    "createdOn": {
      "type": "string",
      "description": "Gives the date that the instance was originally created."
    },
    "descriptor": {
      "type": "string",
      "description": "The display name of the instance"
    },
    "emailDetail": {
      "description": "Email Configuration container for REST API."
    },
    "id": {
      "type": "string",
      "description": "Workday Id or Reference Id of the instance."
    },
    "inactive": {
      "type": "boolean",
      "description": "Indicates template is active or has been disabled."
    },
    "lastUpdated": {
      "type": "string",
      "description": "Last Updated"
    },
    "lastUpdatedBy": {
      "description": "Person who last updated the instance."
    },
    "name": {
      "type": "string",
      "description": "Message Template Name"
    },
    "notificationType": {
      "description": "Notification Type indicates where the template can be used."
    },
    "pushDetail": {
      "description": "Container for push notification data, used in REST API."
    },
    "referenceID": {
      "type": "string",
      "description": "The Reference ID to use for lookups within our Workday Web Services. For \\~supervisory organizations\\~, this is also the 'Organization ID'"
    },
    "usageCount": {
      "type": "integer",
      "description": "Count of instances using this Message Template"
    }
  },
  "required": [
    "PCID",
    "ID",
    "name",
    "notificationType"
  ]
}