Overview
Configuration is provided for establishing connections with the PureCloud service (since October 2020
Genesys Cloud). The configuration is used in the REST Connection Manager.
Before successfully configuring a connection to a PureCloud instance, you have to make sure your instance has OAuth authentication enabled. After OAuth is enabled, created "Client Credentials" client by following these steps:
- Go to the following page: https://apps.mypurecloud.com/directory/#/admin/integrations/oauth
- Press 'Add Client'.
- Set App Name.
- Set Grant Type to 'Client Credentials'.
- Set roles to
or anything else deemed necessary. - Press Save.
After saving, you will be provided with Client ID and Client Secret. Write down this information for further use.
Setup
Press 
icon to get more information about the connection parameters.
Obtain data
Use REST Source component to get data from service resource.
Insert data
Use REST Destination component to insert data into service resource.
Quick Start
In this guide we will show you how to create a connection to PureCloud service using COZYROC's REST Connection Manager.
Step 1. Run "Visual Studio".
Step 2. Right click on "Connection Managers" tab and select "New Connection..."
Step 3. In "Add SSIS Connection Manager" scroll down and select "REST connection manager" and click "Add..."
Step 4. From Configuration combo box select "PureCloud".
Step 5. Enter client_id parameter. The necessary value is found in your PureCloud OAuth "Client Credentials" client page.
Step 6. Enter client_secret. The necessary value is found in your PureCloud OAuth "Client Credentials" client page.
Step 7. Click "Test Connection" to test your connection.
Congratulations! You have now established connection to your PureCloud instance.
In this guide we will show how to read data from PureCloud service resource using COZYROC REST Source component.
Step 1. Select existing "Data Flow task" or create new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Source" component.
Step 3. Double click on "REST Source" component and select PureCloud connection from combo. Select from available PureCloud resources listed in second combo below.
Optionally you can include extra parameters in the grid below if needed.
Step 4. Click on "Columns tab" and select PureCloud resource columns you want to read.
Step 5. Click Preview to make sure all necessary resource columns are included.
Bravo! You have now learned how to read data from PureCloud service.
In this guide we will show how to write data to PureCloud service resource using COZYROC REST Destination component.
Step 1. Select existing "Data Flow task" or create new "Data Flow Task".
Step 2. Open "SSIS Toolbox" and drag and drop COZYROC "REST Destination" component.
Step 3. Double click on "REST Destination" component and select PureCloud connection from combo. Also select resource action and PureCloud resource you want to work on.
Step 4. Click on "Mapping" tab and map the input columns for the process you are configuring.
If you want to provide input for other resource composite objects, change the input above and map the columns.
Done. You have now learned how to write data into PureCloud resource.
Configuration
Base URL address: https://api.mypurecloud.com/api/v2.
- Session
-
The authentication uses a session token.
The authentication has the following user-defined parameters:
- client_id:
- client_secret:
The following request parameters will be automatically processed during the authentication process:
-
Authorization:
Bearer {{=token.Access}}
Documentation: https://developer.mypurecloud.com/api/rest/authorization/.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/alerting/interactionstats/alerts.Documentation: https://developer.mypurecloud.com/api/rest/v2/alerting/index.html#getAlertingInteractionstatsAlerts.
- [Update] action
-
Endpoint URL address:
/alerting/interactionstats/alerts/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/alerting/index.html#putAlertingInteractionstatsAlert.
- [Delete] action
-
Endpoint URL address:
/alerting/interactionstats/alerts/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/alerting/index.html#deleteAlertingInteractionstatsAlert.
- id
A key field. Template: Id.
- name
Template: ShortText.
- dimension
Template: ShortText.
- dimensionValue
Template: ShortText.
- metric
Template: ShortText.
- mediaType
Template: ShortText.
- numericRange
Template: ShortText.
- statistic
Template: ShortText.
- value
Template: LongText.
- ruleId
Template: Id.
- unread
Data type: DT_BOOL
- startDate
Template: DateTime.
- endDate
Template: DateTime.
- notificationUsers
Template: User. An array field. Field components:
-
Uses template:
User. - Contains the following components: manager.
-
Uses template:
- alertTypes
Template: LongText.
- ruleUri
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
- [Read] action
-
Endpoint URL address:
/alerting/interactionstats/rules.Documentation: https://developer.mypurecloud.com/api/rest/v2/alerting/index.html#getAlertingInteractionstatsRules.
- [Create] action
-
Endpoint URL address:
/alerting/interactionstats/rules.Documentation: https://developer.mypurecloud.com/api/rest/v2/alerting/index.html#postAlertingInteractionstatsRules.
- [Update] action
-
Endpoint URL address:
/alerting/interactionstats/rules/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/alerting/index.html#putAlertingInteractionstatsRule.
- [Delete] action
-
Endpoint URL address:
/alerting/interactionstats/rules/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/alerting/index.html#deleteAlertingInteractionstatsRule.
- id
A key field. Template: Id.
- name
Template: ShortText.
- dimension
Template: ShortText.
- dimensionValue
Template: ShortText.
- metric
Template: ShortText.
- mediaType
Template: ShortText.
- numericRange
Template: ShortText.
- statistic
Template: ShortText.
- value
Template: LongText.
- enabled
Data type: DT_BOOL
- inAlarm
Data type: DT_BOOL
- notificationUsers
Template: User. An array field. Field components:
-
Uses template:
User. - Contains the following components: manager.
-
Uses template:
- alertTypes
Template: LongText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/analytics/reporting/schedules.Documentation: https://developer.mypurecloud.com/api/rest/v2/analytics/index.html#getAnalyticsReportingSchedules.
- [Create] action
-
Endpoint URL address:
/analytics/reporting/schedules.Documentation: https://developer.mypurecloud.com/api/rest/v2/analytics/index.html#postAnalyticsReportingSchedules.
- [Update] action
-
Endpoint URL address:
/analytics/reporting/schedules/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/analytics/index.html#putAnalyticsReportingSchedule.
- [Delete] action
-
Endpoint URL address:
/analytics/reporting/schedules/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/analytics/index.html#deleteAnalyticsReportingSchedule.
- id
A key field. Template: Id.
- name
Template: ShortText.
- quartzCronExpression
Template: ShortText.
- nextFireTime
Template: DateTime.
- dateCreated
Template: DateTime.
- dateModified
Template: DateTime.
- description
Template: LongText.
- timeZone
Template: ShortText.
- timePeriod
Template: ShortText.
- interval
Template: ShortText.
- reportFormat
Template: ShortText.
- locale
Template: ShortText.
- enabled
Data type: DT_BOOL
- reportId
Template: Id.
- parameters
Template: LongText.
- lastRun
Template: JobHistory.
- selfUri
Template: ShortText. A read-only field.
- history
-
Template: JobHistory. An array field. The value is gathered from
/analytics/reporting/schedules/{{=item.id}}/historyaddress. The gathered value is processed with{{=response.entities}}expression.Documentation: https://developer.mypurecloud.com/api/rest/v2/analytics/index.html#getAnalyticsReportingScheduleHistory.
- [Read] action
-
Endpoint URL address:
/analytics/conversations/details/query.
The result is extracted from:{{=response.conversations}}.
The action uses POST method.
The result is paginated.The action has the following user-defined parameters:
- query: Required. Specify query JSON statement.
The following request parameters will be automatically processed:
-
application/json:
{{=_.extend( { paging: { pageNumber: parameters.iterator, pageSize: parameters.batchSize } }, parameters.get('query') && JSON.parse(parameters.query) )}}
- conversationId
A key field. Template: Id.
- conversationStart
Template: DateTime.
- conversationEnd
Template: DateTime.
- mediaStatsMinConversationMos
Data type: DT_I4
- mediaStatsMinConversationRFactor
Data type: DT_I4
- participants
An array field. Field components:
-
Uses template:
Id. - Contains the following components: participantId, participantName, userId, purpose, externalContactId, externalOrganizationId, flaggedReason, sessions.
-
Uses template:
- evaluations
An array field. Field components:
-
Uses template:
Id. - Contains the following components: evaluationId, evaluatorId, userId, eventTime, queueId, formId, contextId, formName, oTotalScore, oTotalCriticalScore.
-
Uses template:
- surveys
An array field. Field components:
-
Uses template:
Id. - Contains the following components: surveyId, surveyFormId, surveyFormName, surveyFormContextId, eventTime, userId, queueId, surveyStatus, surveyPromoterScore, surveyCompletedDate, oSurveyTotalScore.
-
Uses template:
- divisionIds
Template: LongText.
Based on resource template Aggregate Query T.
- [Read Conversation] action
-
Endpoint URL address:
/analytics/conversations/aggregates/query.Documentation: https://developer.mypurecloud.com/api/rest/v2/analytics/conversation_aggregate.html.
- [Read Queue Observations] action
-
Endpoint URL address:
/analytics/queues/observations/query.Documentation: https://developer.mypurecloud.com/api/rest/v2/analytics/queue.html.
- [Read Evaluation] action
-
Endpoint URL address:
/analytics/evaluations/aggregates/query.Documentation: https://developer.mypurecloud.com/api/rest/v2/analytics/evaluations.html.
- [Read User Status] action
-
Endpoint URL address:
/analytics/users/aggregates/query.Documentation: https://developer.mypurecloud.com/api/rest/v2/analytics/user_aggregate.html.
- [Read User Status Observations] action
-
Endpoint URL address:
/analytics/users/observations/query.Documentation: https://developer.mypurecloud.com/api/rest/v2/analytics/user_observation.html.
- [Read Survey] action
-
Endpoint URL address:
/analytics/surveys/aggregates/query.Documentation: https://developer.mypurecloud.com/api/rest/v2/analytics/index.html#postAnalyticsSurveysAggregatesQuery.
- [Read Flow] action
-
Endpoint URL address:
/analytics/flows/aggregates/query.Documentation: https://developer.mypurecloud.com/api/rest/v2/analytics/index.html#postAnalyticsFlowsAggregatesQuery.
- [Read] action
-
Endpoint URL address:
/analytics/users/details/query.
The result is extracted from:{{=response.userDetails}}.
The action uses POST method.The action has the following user-defined parameters:
- query: Required. Specify query JSON statement.
The following request parameters will be automatically processed:
-
application/json:
{{=_.extend( { paging: { pageNumber: parameters.iterator, pageSize: parameters.batchSize } }, parameters.get('query') && JSON.parse(parameters.query) )}}
- userId
Template: Id.
- primaryPresence
An array field. Field components:
-
Uses template:
DateTime. - Contains the following components: startTime, endTime, systemPresence, organizationPresenceId, durationMilliseconds.
-
Uses template:
- routingStatus
An array field. Field components:
-
Uses template:
DateTime. - Contains the following components: startTime, endTime, routingStatus, durationMilliseconds.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/analytics/reporting/metadata.
The result is extracted from:{{=response.entities}}.
- id
A key field. Template: Id.
- name
Template: ShortText.
- title
Template: ShortText.
- description
Template: LongText.
- keywords
Template: LongText.
- availableLocales
Template: LongText.
- parameters
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: name, parameterType, domain, required.
-
Uses template:
- exampleUrl
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/analytics/reporting/exports.
The result is extracted from:{{=response.entities}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/analytics/index.html#getAnalyticsReportingExports.
- [Create] action
-
Endpoint URL address:
/analytics/reporting/exports.Documentation: https://developer.mypurecloud.com/api/rest/v2/analytics/index.html#postAnalyticsReportingExports.
- id
A key field. Template: Id.
- name
Template: ShortText.
- status
Template: ShortText. A read-only field.
- timeZone
Field components:
-
Uses template:
Id. - Contains the following components: dstsavings, rawOffset, id, displayName.
-
Uses template:
- exportFormat
Template: ShortText.
- interval
Template: ShortText.
- downloadUrl
Template: ShortText. A read-only field.
- viewType
Template: ShortText.
- exportErrorMessagesType
Template: ShortText.
- filter
Field components:
-
Uses template:
LongText. - Contains the following components: mediaTypes, queueIds, skillIds, skillGroups, languageIds, languageGroups, directions, wrapUpCodes, dnisList, filterQueuesByUserIds, filterUsersByQueueIds, userIds, addressTos, addressFroms, outboundCampaignIds, outboundContactListIds, contactIds, aniList, durationsMilliseconds, evaluationScore, evaluationCriticalScore, evaluationFormIds, evaluatedAgentIds, evaluatorIds, transferred, abandoned, messageTypes, divisionIds, surveyFormIds, surveyTotalScore, surveyNpsScore, showSecondaryStatus, agentDurationSortOrder, waitingDurationSortOrder, interactingDurationSortOrder, agentName, skillsList, languageList, mos, surveyQuestionGroupScore, surveyPromoterScore, surveyFormContextIds, conversationIds, isEnded, isSurveyed, surveyScores, promoterScores, isCampaign, surveyStatuses, conversationProperties, isBlindTransferred, isConsulted, isConsultTransferred, remoteParticipants.
-
Uses template:
- read
Data type: DT_BOOL
- createdDateTime
Template: DateTime. A read-only field.
- modifiedDateTime
Template: DateTime. A read-only field.
- locale
Template: ShortText.
- percentageComplete
Template: LongText. A read-only field.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read name] action
-
Endpoint URL address:
/architect/dependencytracking.The action has the following user-defined parameters:
- name: Required. Specify object name.
Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#getArchitectDependencytracking.
- [Read updated] action
-
Endpoint URL address:
/architect/dependencytracking/updatedresourceconsumers.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#getArchitectDependencytrackingUpdatedresourceconsumers.
The resource includes the fields from the DependencyObject template.
- consumedResources
Template: DependencyObject. An array field.
- consumingResources
Template: DependencyObject. An array field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/architect/dependencytracking/types.
- id
Template: Id.
- name
Template: ShortText.
- versioned
Data type: DT_BOOL
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/architect/emergencygroups.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#getArchitectEmergencygroups.
- [Create] action
-
Endpoint URL address:
/architect/emergencygroups.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#postArchitectEmergencygroups.
- [Update] action
-
Endpoint URL address:
/architect/emergencygroups/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#putArchitectEmergencygroup.
- [Delete] action
-
Endpoint URL address:
/architect/emergencygroups/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#deleteArchitectEmergencygroup.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText.
- createdBy
Template: ShortText.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText.
- createdByApp
Template: ShortText.
- enabled
Data type: DT_BOOL
- emergencyCallFlows
An array field. Field components:
- Contains the following components: emergencyFlow, ivrs.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/architect/ivrs.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#getArchitectIvrs.
- [Create] action
-
Endpoint URL address:
/architect/ivrs.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#postArchitectIvrs.
- [Update] action
-
Endpoint URL address:
/architect/ivrs/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#putArchitectIvr.
- [Delete] action
-
Endpoint URL address:
/architect/ivrs/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#deleteArchitectIvr.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText.
- createdBy
Template: ShortText.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText.
- createdByApp
Template: ShortText.
- dnis
Template: LongText.
- openHoursFlow
Template: UriReference.
- closedHoursFlow
Template: UriReference.
- holidayHoursFlow
Template: UriReference.
- scheduleGroup
Template: UriReference.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/architect/prompts.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#getArchitectPrompts.
- [Create] action
-
Endpoint URL address:
/architect/prompts.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#postArchitectPrompts.
- [Update] action
-
Endpoint URL address:
/architect/prompts/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#putArchitectPrompt.
- [Delete] action
-
Endpoint URL address:
/architect/prompts.The following request parameters will be automatically processed:
-
id:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#deleteArchitectPrompts.
-
id:
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- resources
Template: PromptAsset. An array field.
- currentOperation
Template: Operation.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/architect/prompts/{{=parameters.promptId}}/resources.The action has the following user-defined parameters:
- promptId: Required. Specify user prompt identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#getArchitectPromptResources.
- [Create] action
-
Endpoint URL address:
/architect/prompts/{{=item.promptId}}/resources.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#postArchitectPromptResources.
- [Update] action
-
Endpoint URL address:
/api/v2/architect/prompts/{{=item.promptId}}/resources/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#putArchitectPromptResource.
- [Delete] action
-
Endpoint URL address:
/api/v2/architect/prompts/{{=item.promptId}}/resources/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#deleteArchitectPromptResource.
The resource includes the fields from the PromptAsset template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/architect/schedulegroups.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#getArchitectSchedulegroups.
- [Create] action
-
Endpoint URL address:
/architect/schedulegroups.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#postArchitectSchedulegroups.
- [Update] action
-
Endpoint URL address:
/architect/schedulegroups/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#putArchitectSchedulegroup.
- [Delete] action
-
Endpoint URL address:
/architect/schedulegroups/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#deleteArchitectSchedulegroup.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText.
- createdBy
Template: ShortText.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText.
- createdByApp
Template: ShortText.
- timeZone
Template: ShortText.
- openSchedules
Template: UriReference. An array field.
- closedSchedules
Template: UriReference. An array field.
- holidaySchedules
Template: UriReference. An array field.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/architect/schedules.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#getArchitectSchedules.
- [Create] action
-
Endpoint URL address:
/architect/schedules.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#postArchitectSchedules.
- [Update] action
-
Endpoint URL address:
/architect/schedules/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#putArchitectSchedule.
- [Delete] action
-
Endpoint URL address:
/architect/schedules/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#deleteArchitectSchedule.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText.
- createdBy
Template: ShortText.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText.
- createdByApp
Template: ShortText.
- start
Template: DateTime.
- end
Template: DateTime.
- rrule
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/architect/systemprompts.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#getArchitectSystemprompts.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- resources
Template: PromptAsset. An array field.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/architect/systemprompts/{{=parameters.promptId}}/resources.The action has the following user-defined parameters:
- promptId: Required. Specify system prompt identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#getArchitectSystempromptResources.
- [Create] action
-
Endpoint URL address:
/architect/systemprompts/{{=item.promptId}}/resources.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#postArchitectSystempromptResources.
- [Update] action
-
Endpoint URL address:
/api/v2/architect/systemprompts/{{=item.promptId}}/resources/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#putArchitectSystempromptResource.
- [Delete] action
-
Endpoint URL address:
/api/v2/architect/systemprompts/{{=item.promptId}}/resources/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#deleteArchitectSystempromptResource.
The resource includes the fields from the PromptAsset template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/flows.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#getFlows.
- [Create] action
-
Endpoint URL address:
/flows.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#postFlows.
- [Update] action
-
Endpoint URL address:
/flows/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#putFlow.
- [Delete] action
-
Endpoint URL address:
/flows/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#deleteFlow.
The resource includes the fields from the Flow template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/flows/{{=parameters.flowId}}/versions.The action has the following user-defined parameters:
- flowId: Required. Specify flow identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#getFlowVersions.
- [Create] action
-
Endpoint URL address:
/flows/{{=item.flowId}}/versions.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#postFlowVersions.
The resource includes the fields from the FlowVersion template.
- flowId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/flows/datatables.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#getFlowsDatatables.
- [Create] action
-
Endpoint URL address:
/flows/datatables.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#postFlowsDatatables.
- [Update] action
-
Endpoint URL address:
/flows/datatables/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#putFlowsDatatable.
- [Delete] action
-
Endpoint URL address:
/flows/datatables/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#deleteFlowsDatatable.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- schema
Field components:
-
Uses template:
Id. - Contains the following components: Id, $schema, title, description, type, required, properties, additionalProperties.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/flows/datatables/{{=item.datatableId}}/rows.The action has the following user-defined parameters:
- datatableId: Required. Specify datatable identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#getFlowsDatatableRows.
- [Create] action
-
Endpoint URL address:
/flows/datatables/{{=item.datatableId}}/rows.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#postFlowsDatatableRows.
- [Update] action
-
Endpoint URL address:
/flows/datatables/{{=item.datatableId}}/rows/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#putFlowsDatatableRow.
- [Delete] action
-
Endpoint URL address:
/flows/datatables/{{=item.datatableId}}/rows/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/architect/index.html#deleteFlowsDatatableRow.
- id
A key field. Template: Id.
- datatableId
Template: Id.
- row
Template: LongText. The gathered value is processed with
{{=item}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/attributes.Documentation: https://developer.mypurecloud.com/api/rest/v2/attributes/index.html#getAttributes.
- [Read query] action
-
Endpoint URL address:
/attributes/query.Documentation: https://developer.mypurecloud.com/api/rest/v2/attributes/index.html#postAttributesQuery.
- [Create] action
-
Endpoint URL address:
/attributes.Documentation: https://developer.mypurecloud.com/api/rest/v2/attributes/index.html#postAttributes.
- [Update] action
-
Endpoint URL address:
/attributes/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/attributes/index.html#putAttribute.
- [Delete] action
-
Endpoint URL address:
/attributes/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/attributes/index.html#deleteAttribute.
The resource includes the fields from the AttributeT template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/authorization/divisions.Documentation: https://developer.mypurecloud.com/api/rest/v2/authorization/index.html#getAuthorizationDivisions.
- [Create] action
-
Endpoint URL address:
/authorization/divisions.Documentation: https://developer.mypurecloud.com/api/rest/v2/authorization/index.html#postAuthorizationDivisions.
- [Update] action
-
Endpoint URL address:
/authorization/divisions/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/authorization/index.html#putAuthorizationDivision.
- [Delete] action
-
Endpoint URL address:
/authorization/divisions/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/authorization/index.html#deleteAuthorizationDivision.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- homeDivision
Data type: DT_BOOL
- objectCounts
Template: LongText. A read-only field.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/authorization/permissions.Documentation: https://developer.mypurecloud.com/api/rest/v2/authorization/index.html#getAuthorizationPermissions.
- id
A key field. Template: Id.
- name
Template: ShortText.
- domain
Template: ShortText.
- permissionMap
Template: LongText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/authorization/roles.Documentation: https://developer.mypurecloud.com/api/rest/v2/authorization/index.html#getAuthorizationRoles.
- [Create] action
-
Endpoint URL address:
/authorization/roles.Documentation: https://developer.mypurecloud.com/api/rest/v2/authorization/index.html#postAuthorizationRoles.
- [Update] action
-
Endpoint URL address:
/authorization/roles/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/authorization/index.html#putAuthorizationRole.
- [Delete] action
-
Endpoint URL address:
/authorization/roles/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/authorization/index.html#deleteAuthorizationRole.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- defaultRoleId
Template: Id.
- permissions
Template: LongText.
- permissionPolicies
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: domain, entityName, policyName, policyDescription, actionSet, namedResources, allowConditions, resourceConditionNode.
-
Uses template:
- userCount
Data type: DT_I4
- roleNeedsUpdate
Data type: DT_BOOL
- base
Data type: DT_BOOL
- default
Data type: DT_BOOL
- selfUri
Template: ShortText. A read-only field.
- [Read] action
-
Endpoint URL address:
/billing/reports/billableusage.
The result is extracted from:{{=response.usages}}.The action has the following user-defined parameters:
- startDate: Required. Specify start date. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
- endDate: Required. Specify end date. For example: yyyy-MM-ddTHH:mm:ss.SSSZ
- name
Template: ShortText.
- totalUsage
Template: ShortText.
- resources
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: name, date.
-
Uses template:
- [Read] action
-
Endpoint URL address:
/billing/trusteebillingoverview/{{=parameters.trustorOrgId}}.
The result is extracted from:{{=response.usages}}.The action has the following user-defined parameters:
- trustorOrgId: Required. Specify organization identifier.
- name
Template: ShortText.
- partNumber
Template: ShortText.
- grouping
Template: ShortText.
- unitOfMeasureType
Template: ShortText.
- usageQuantity
Template: ShortText.
- overagePrice
Template: ShortText.
- prepayQuantity
Template: ShortText.
- prepayPrice
Template: ShortText.
- usageNotes
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contentmanagement/auditquery.
The result is extracted from:{{=response.results.entities}}.
The action uses POST method.The action has the following user-defined parameters:
- query: Required. Specify query JSON statement.
The following request parameters will be automatically processed:
-
application/json:
{{=JSON.parse(parameters.query)}}
- id
Template: Id.
- name
Template: ShortText.
- body
Field components:
-
Uses template:
Id. - Contains the following components: id, name, selfUri.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contentmanagement/workspaces/{{=parameters.workspaceId}}/documents.The action has the following user-defined parameters:
- workspaceId: Required. Specify workspace identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#getContentmanagementWorkspaceDocuments.
- [Create] action
-
Endpoint URL address:
/contentmanagement/documents.Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#postContentmanagementDocuments.
- [Update] action
-
Endpoint URL address:
/contentmanagement/documents/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#postContentmanagementDocument.
- [Delete] action
-
Endpoint URL address:
/contentmanagement/documents/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#deleteContentmanagementDocument.
- id
A key field. Template: Id.
- name
Template: ShortText.
- changeNumber
Data type: DT_I4
- dateCreated
Template: DateTime.
- dateModified
Template: DateTime.
- dateUploaded
Template: DateTime.
- contentUri
Template: ShortText.
- workspace
Template: UriReference.
- createdBy
Template: UriReference.
- uploadedBy
Template: UriReference.
- contentType
Template: ShortText.
- contentLength
Data type: DT_I4
- systemType
Template: ShortText.
- filename
Template: ShortText.
- pageCount
Data type: DT_I4
- read
Data type: DT_BOOL
- callerAddress
Template: ShortText.
- receiverAddress
Template: ShortText.
- tags
Template: LongText.
- tagValues
Template: TagValue. An array field.
- attributes
An array field. Field components:
-
Uses template:
AttributeT. - Contains the following components: attribute, values.
-
Uses template:
- thumbnails
Template: Image. An array field.
- uploadStatus
Template: UriReference.
- uploadDestinationUri
Template: ShortText.
- uploadMethod
Template: ShortText.
- lockInfo
Field components:
-
Uses template:
UriReference. - Contains the following components: lockedBy, dateCreated, dateExpires, action.
-
Uses template:
- acl
Template: LongText.
- sharingStatus
Template: ShortText.
- sharingUri
Template: ShortText.
- downloadSharingUri
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
- addTags
Template: LongText. A composite field.
- removeTags
Template: LongText. A composite field.
- addTagIds
Template: LongText. A composite field.
- removeTagIds
Template: LongText. A composite field.
- updateAttributes
An array field. Field components:
-
Uses template:
AttributeT. - Contains the following components: attribute, values.
-
Uses template:
- removeAttributes
Template: LongText. A composite field.
- content
Data type: DT_IMAGE The value is gathered from
/contentmanagement/documents/{{=item.id}}/contentaddress. The gathered value is processed with{{=connection.execute({ url: response.contentLocationUri })}}expression. The value is sent to/contentmanagement/documents/{{=item.id}}/contentaddress.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contentmanagement/query.
The result is extracted from:{{=response.results.entities}}.
The action uses POST method.The action has the following user-defined parameters:
- query: Required. Specify query JSON statement.
The following request parameters will be automatically processed:
-
application/json:
{{=JSON.parse(parameters.query)}}
Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#postContentmanagementQuery.
- id
Template: Id.
- name
Template: ShortText.
- body
Field components:
-
Uses template:
Id. - Contains the following components: id, name, selfUri.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contentmanagement/shares.Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#getContentmanagementShares.
- [Create] action
-
Endpoint URL address:
/contentmanagement/shares.Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#postContentmanagementShares.
- [Delete] action
-
Endpoint URL address:
/contentmanagement/shares/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#deleteContentmanagementShare.
- id
A key field. Template: Id.
- name
Template: ShortText.
- sharedEntityType
Template: ShortText.
- sharedEntity
Template: UriReference.
- memberType
Template: ShortText.
- member
Template: UriReference.
- sharedBy
Template: UriReference.
- workspace
Template: UriReference.
- user
Template: User.
- group
Template: Group.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contentmanagement/workspaces.Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#getContentmanagementWorkspaces.
- [Create] action
-
Endpoint URL address:
/contentmanagement/workspaces.Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#postContentmanagementWorkspaces.
- [Update] action
-
Endpoint URL address:
/contentmanagement/workspaces/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#putContentmanagementWorkspace.
- [Delete] action
-
Endpoint URL address:
/contentmanagement/workspaces/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#deleteContentmanagementWorkspace.
- id
A key field. Template: Id.
- name
Template: ShortText.
- type
Template: ShortText.
- isCurrentUserWorkspace
Data type: DT_BOOL
- user
Template: UriReference.
- bucket
Template: ShortText.
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- summary
Field components:
- Contains the following components: totalDocumentCount, totalDocumentByteCount.
- acl
Template: LongText. A composite field.
- description
Template: LongText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contentmanagement/workspaces/{{=parameters.workspaceId}}/members.The action has the following user-defined parameters:
- workspaceId: Required. Specify workspace identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#getContentmanagementWorkspaceMembers.
- [Delete] action
-
Endpoint URL address:
/contentmanagement/workspaces/{{=item.workspace.id}}/members/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#deleteContentmanagementWorkspaceMember.
- id
A key field. Template: Id.
- name
Template: ShortText.
- workspace
Template: UriReference.
- memberType
Template: ShortText.
- member
Template: UriReference.
- user
Template: User.
- group
Template: Group.
- securityProfile
Field components:
-
Uses template:
Id. - Contains the following components: id, name, permissions, selfUri.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/contentmanagement/workspaces/{{=parameters.workspaceId}}/tagvalues.The action has the following user-defined parameters:
- workspaceId: Required. Specify workspace identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#getContentmanagementWorkspaceTagvalues.
- [Create] action
-
Endpoint URL address:
/contentmanagement/workspaces/{{=item.workspaceId}}/tagvalues.Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#postContentmanagementWorkspaceTagvalues.
- [Update] action
-
Endpoint URL address:
/contentmanagement/workspaces/{{=item.workspaceId}}/tagvalues/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#putContentmanagementWorkspaceTagvalue.
- [Delete] action
-
Endpoint URL address:
/contentmanagement/workspaces/{{=item.workspaceId}}/tagvalues/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/contentmanagement/index.html#deleteContentmanagementWorkspaceTagvalue.
The resource includes the fields from the TagValue template.
- workspaceId
A key field. Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/conversations/calls/history.Documentation: https://developer.mypurecloud.com/api/rest/v2/conversations/index.html#getConversationsCallsHistory.
- id
A key field. Template: Id.
- name
Template: ShortText.
- participants
An array field. Field components:
-
Uses template:
Id. - Contains the following components: id, name, address, startTime, endTime, purpose, direction, ani, dnis, user, queue, group, disconnectType, externalContact, externalOrganization, didInteract, sipResponseCodes, flaggedReason.
-
Uses template:
- direction
Template: ShortText.
- wentToVoicemail
Data type: DT_BOOL
- missedCall
Data type: DT_BOOL
- startTime
Template: DateTime.
- wasConference
Data type: DT_BOOL
- wasCallback
Data type: DT_BOOL
- hadScreenShare
Data type: DT_BOOL
- hadCobrowse
Data type: DT_BOOL
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/externalcontacts/contacts.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#getExternalcontactsContacts.
- [Create] action
-
Endpoint URL address:
/externalcontacts/contacts.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#postExternalcontactsContacts.
- [Update] action
-
Endpoint URL address:
/externalcontacts/contacts/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#putExternalcontactsContact.
- [Delete] action
-
Endpoint URL address:
/externalcontacts/contacts/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#deleteExternalcontactsContact.
The resource includes the fields from the ExternalContact template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/externalcontacts/contacts/{{=parameters.contactId}}/notes.The action has the following user-defined parameters:
- contactId: Required. Specify external contact identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#getExternalcontactsContactNotes.
- [Create] action
-
Endpoint URL address:
/externalcontacts/contacts/{{=item.contactId}}/notes.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#postExternalcontactsContactNotes.
- [Update] action
-
Endpoint URL address:
/externalcontacts/contacts/{{=item.contactId}}/notes/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#putExternalcontactsContactNote.
- [Delete] action
-
Endpoint URL address:
/externalcontacts/contacts/{{=item.contactId}}/notes/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#deleteExternalcontactsContactNote.
The resource includes the fields from the Note template.
- contactId
A key field. Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/externalcontacts/organizations.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#getExternalcontactsOrganizations.
- [Create] action
-
Endpoint URL address:
/externalcontacts/organizations.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#postExternalcontactsOrganizations.
- [Update] action
-
Endpoint URL address:
/externalcontacts/organizations/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#putExternalcontactsOrganization.
- [Delete] action
-
Endpoint URL address:
/externalcontacts/organizations/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#deleteExternalcontactsOrganization.
The resource includes the fields from the ExternalOrganization template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/externalcontacts/organizations/{{=parameters.organizationId}}/notes.The action has the following user-defined parameters:
- organizationId: Required. Specify external organization identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#getExternalcontactsOrganizationNotes.
- [Create] action
-
Endpoint URL address:
/externalcontacts/organizations/{{=item.organizationId}}/notes.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#postExternalcontactsOrganizationNotes.
- [Update] action
-
Endpoint URL address:
/externalcontacts/organizations/{{=item.organizationId}}/notes/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#putExternalcontactsOrganizationNote.
- [Delete] action
-
Endpoint URL address:
/externalcontacts/organizations/{{=item.organizationId}}/notes/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#deleteExternalcontactsOrganizationNote.
The resource includes the fields from the Note template.
- organizationId
A key field. Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/externalcontacts/organizations/{{=parameters.organizationId}}/relationships.The action has the following user-defined parameters:
- organizationId: Required. Specify external organization identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#getExternalcontactsOrganizationRelationships.
- [Create] action
-
Endpoint URL address:
/externalcontacts/relationships.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#postExternalcontactsRelationships.
- [Update] action
-
Endpoint URL address:
/externalcontacts/relationships/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#putExternalcontactsRelationship.
- [Delete] action
-
Endpoint URL address:
/externalcontacts/relationships/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/externalcontacts/index.html#deleteExternalcontactsRelationship.
- id
A key field. Template: Id.
- name
Template: ShortText.
- user
Template: User.
- externalOrganization
Template: ExternalOrganization.
- relationship
Template: ShortText.
- externalDataSources
Template: ExternalDataSource. An array field. A read-only field.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/fax/documents.Documentation: https://developer.mypurecloud.com/api/rest/v2/fax/index.html#getFaxDocuments.
- [Update] action
-
Endpoint URL address:
/fax/documents/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/fax/index.html#putFaxDocument.
- [Delete] action
-
Endpoint URL address:
/fax/documents/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/fax/index.html#deleteFaxDocument.
- id
A key field. Template: Id.
- name
Template: ShortText.
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- contentUri
Template: ShortText.
- workspace
Template: UriReference.
- createdBy
Template: UriReference.
- contentType
Template: ShortText.
- contentLength
Data type: DT_I4
- filename
Template: ShortText.
- read
Data type: DT_BOOL
- pageCount
Data type: DT_I4
- callerAddress
Template: ShortText.
- receiverAddress
Template: ShortText.
- thumbnails
Template: Image. An array field.
- sharingUri
Template: ShortText.
- downloadSharingUri
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
- content
Data type: DT_IMAGE The value is gathered from
/fax/documents/{{=item.id}}/contentaddress. The gathered value is processed with{{=connection.execute({ url: response.contentLocationUri })}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/gdpr/requests.Documentation: https://developer.mypurecloud.com/api/rest/v2/generaldataprotectionregulation/index.html#getGdprRequests.
- [Create] action
-
Endpoint URL address:
/gdpr/requests.Documentation: https://developer.mypurecloud.com/api/rest/v2/generaldataprotectionregulation/index.html#postGdprRequests.
- id
A key field. Template: Id.
- name
Template: ShortText.
- createdBy
Template: UriReference.
- replacementTerms
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: type, existingValue, updatedValue.
-
Uses template:
- requestType
Template: ShortText.
- createdDate
Template: DateTime. A read-only field.
- status
Template: ShortText.
- subject
Field components:
-
Uses template:
ShortText. - Contains the following components: name, userId, externalContactId, dialerContactId, addresses, phoneNumbers, emailAddresses.
-
Uses template:
- resultsUrl
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/greetings.Documentation: https://developer.mypurecloud.com/api/rest/v2/greetings/index.html#getGreetings.
- [Create] action
-
Endpoint URL address:
/greetings.Documentation: https://developer.mypurecloud.com/api/rest/v2/greetings/index.html#postGreetings.
- [Update] action
-
Endpoint URL address:
/greetings/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/greetings/index.html#putGreeting.
- [Delete] action
-
Endpoint URL address:
/greetings/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/greetings/index.html#deleteGreeting.
The resource includes the fields from the Greeting template.
- media
-
The value is gathered from
/greetings/{{=item.id}}/mediaaddress. Field components:-
Uses template:
Id. - Contains the following components: id, mediaFileUri, mediaImageUri.
Documentation: https://developer.mypurecloud.com/api/rest/v2/greetings/index.html#getGreetingMedia.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups/{{=parameters.groupId}}/greetings.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/greetings/index.html#getGroupGreetings.
- [Create] action
-
Endpoint URL address:
/groups/{{=item.groupId}}/greetings.Documentation: https://developer.mypurecloud.com/api/rest/v2/greetings/index.html#postGroupGreetings.
The resource includes the fields from the Greeting template.
- groupId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/greetings.The action has the following user-defined parameters:
- userId: Required. Specify user identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/greetings/index.html#getUserGreetings.
- [Create] action
-
Endpoint URL address:
/users/{{=item.userId}}/greetings.Documentation: https://developer.mypurecloud.com/api/rest/v2/greetings/index.html#postUserGreetings.
The resource includes the fields from the Greeting template.
- groupId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups.Documentation: https://developer.mypurecloud.com/api/rest/v2/groups/index.html#getGroups.
- [Read search] action
-
Endpoint URL address:
/groups/search.
The result is extracted from:{{=response.results}}.
The action uses POST method.The action has the following user-defined parameters:
- query: Required. Specify query JSON statement.
The following request parameters will be automatically processed:
-
application/json:
{{=JSON.parse(parameters.query)}}
Documentation: https://developer.mypurecloud.com/api/rest/v2/groups/index.html#postGroupsSearch.
- [Create] action
-
Endpoint URL address:
/groups.Documentation: https://developer.mypurecloud.com/api/rest/v2/groups/index.html#postGroups.
- [Update] action
-
Endpoint URL address:
/groups/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/groups/index.html#putGroup.
- [Delete] action
-
Endpoint URL address:
/groups/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/groups/index.html#deleteGroup.
The resource includes the fields from the Group template.
- voicemail
A read-only field. Field components:
- Contains the following components: mailbox, policy.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/groups/{{=parameters.groupId}}/members.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/groups/index.html#getGroupMembers.
- [Read individual] action
-
Endpoint URL address:
/groups/{{=parameters.groupId}}/individuals.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/groups/index.html#getGroupIndividuals.
- [Create] action
-
Endpoint URL address:
/groups/{{=item.groupId}}/members.The following request parameters will be automatically processed:
-
application/json:
{{={ memberIds: item.memberIds.split(',') } }}
Documentation: https://developer.mypurecloud.com/api/rest/v2/groups/index.html#postGroupMembers.
-
application/json:
- [Delete] action
-
Endpoint URL address:
/groups/{{=item.groupId}}/members.The following request parameters will be automatically processed:
-
ids:
{{=item.memberIds}}
Documentation: https://developer.mypurecloud.com/api/rest/v2/groups/index.html#deleteGroupMembers.
-
ids:
The resource includes the fields from the User template.
- groupId
A key field. Template: Id.
- memberIds
Template: LongText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/identityproviders.Documentation: https://developer.mypurecloud.com/api/rest/v2/identityprovider/index.html#getIdentityproviders.
- id
A key field. Template: Id.
- name
Template: ShortText.
- disabled
Data type: DT_BOOL
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/integrations.Documentation: https://developer.mypurecloud.com/api/rest/v2/integrations/index.html#getIntegrations.
- [Create] action
-
Endpoint URL address:
/integrations.Documentation: https://developer.mypurecloud.com/api/rest/v2/integrations/index.html#postIntegrations.
- [Update] action
-
Endpoint URL address:
/integrations/{{=item.id}}.
The action uses PATCH method.Documentation: https://developer.mypurecloud.com/api/rest/v2/integrations/index.html#patchIntegration.
- [Delete] action
-
Endpoint URL address:
/integrations/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/integrations/index.html#deleteIntegration.
- id
A key field. Template: Id.
- name
Template: ShortText.
- integrationType
Field components:
-
Uses template:
Id. - Contains the following components: id, name, description, provider, category, images, configPropertiesSchemaUri, configAdvancedSchemaUri, helpUri, termsOfServiceUri, vendorName, vendorWebsiteUri, marketplaceUri, faqUri, privacyPolicyUri, supportContactUri, salesContactUri, helpLinks, credentials, nonInstallable, maxInstances, userPermissions, selfUri.
-
Uses template:
- notes
Template: LongText.
- intendedState
Template: ShortText.
- config
Field components:
- Contains the following components: current.
- reportedState
Field components:
-
Uses template:
ShortText. - Contains the following components: code, effective, detail, lastUpdated.
-
Uses template:
- attributes
Template: LongText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/integrations/actions.Documentation: https://developer.mypurecloud.com/api/rest/v2/integrations/index.html#getIntegrationsActions.
- [Create] action
-
Endpoint URL address:
/integrations/actions.Documentation: https://developer.mypurecloud.com/api/rest/v2/integrations/index.html#postIntegrationsActions.
- [Update] action
-
Endpoint URL address:
/integrations/actions/{{=item.id}}.
The action uses PATCH method.Documentation: https://developer.mypurecloud.com/api/rest/v2/integrations/index.html#patchIntegrationsAction.
- [Delete] action
-
Endpoint URL address:
/integrations/actions/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/integrations/index.html#deleteIntegrationsAction.
The resource includes the fields from the Action template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/integrations/actions/drafts.Documentation: https://developer.mypurecloud.com/api/rest/v2/integrations/index.html#getIntegrationsActionsDrafts.
- [Create] action
-
Endpoint URL address:
/integrations/actions/drafts.Documentation: https://developer.mypurecloud.com/api/rest/v2/integrations/index.html#postIntegrationsActionsDrafts.
The resource includes the fields from the Action template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/integrations/credentials.Documentation: https://developer.mypurecloud.com/api/rest/v2/integrations/index.html#getIntegrationsCredentials.
- [Create] action
-
Endpoint URL address:
/integrations/credentials.Documentation: https://developer.mypurecloud.com/api/rest/v2/integrations/index.html#postIntegrationsCredentials.
- [Update] action
-
Endpoint URL address:
/integrations/credentials/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/integrations/index.html#putIntegrationsCredential.
- [Delete] action
-
Endpoint URL address:
/integrations/credentials/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/integrations/index.html#deleteIntegrationsCredential.
- id
A key field. Template: Id.
- name
Template: ShortText.
- createdDate
Template: DateTime. A read-only field.
- modifiedDate
Template: DateTime. A read-only field.
- type
Field components:
-
Uses template:
Id. - Contains the following components: id, name, properties, displayOrder, required.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
- credentialFields
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/integrations/eventlog.Documentation: https://developer.mypurecloud.com/api/rest/v2/integrations/index.html#getIntegrationsEventlog.
- id
A key field. Template: Id.
- selfUri
Template: ShortText. A read-only field.
- correlationId
Template: Id.
- timestamp
Template: DateTime.
- level
Template: ShortText.
- eventCode
Template: ShortText.
- message
Template: Message.
- entities
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: entityType, id.
-
Uses template:
- contextAttributes
Template: LongText.
- detailMessage
Template: Message.
- user
Template: User.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/integrations/types.Documentation: https://developer.mypurecloud.com/api/rest/v2/integrations/index.html#getIntegrationsTypes.
- id
Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- provider
Template: ShortText.
- category
Template: ShortText.
- images
Template: Image. An array field.
- configPropertiesSchemaUri
Template: ShortText.
- configAdvancedSchemaUri
Template: ShortText.
- helpUri
Template: ShortText.
- termsOfServiceUri
Template: ShortText.
- vendorName
Template: ShortText.
- vendorWebsiteUri
Template: ShortText.
- marketplaceUri
Template: ShortText.
- faqUri
Template: ShortText.
- privacyPolicyUri
Template: ShortText.
- supportContactUri
Template: ShortText.
- salesContactUri
Template: ShortText.
- helpLinks
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: uri, title, description.
-
Uses template:
- credentials
Template: LongText.
- nonInstallable
Data type: DT_BOOL
- maxInstances
Data type: DT_I4
- userPermissions
Template: LongText.
- selfUri
Template: ShortText. A read-only field.
- [Read] action
-
Endpoint URL address:
/locations.
The result is extracted from:{{=response.entities}}.
The result is paginated.Documentation: https://developer.mypurecloud.com/api/rest/v2/locations/index.html#getLocations.
- [Read search] action
-
Endpoint URL address:
/locations/search.
The result is extracted from:{{=response.results}}.
The action uses POST method.
The result is paginated.The action has the following user-defined parameters:
- query: Specify query JSON statement.
The following request parameters will be automatically processed:
-
application/json:
{{=_.extend( { pageNumber: parameters.iterator, pageSize: parameters.batchSize }, parameters.get('query') && JSON.parse(parameters.query) )}}
Documentation: https://developer.mypurecloud.com/api/rest/v2/locations/index.html#postLocationsSearch.
The resource includes the fields from the Location template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/messaging/integrations/facebook.Documentation: https://developer.mypurecloud.com/api/rest/v2/messaging/index.html#getMessagingIntegrationsFacebook.
- [Create] action
-
Endpoint URL address:
/messaging/integrations/facebook.Documentation: https://developer.mypurecloud.com/api/rest/v2/messaging/index.html#postMessagingIntegrationsFacebook.
- [Delete] action
-
Endpoint URL address:
/messaging/integrations/facebook/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/messaging/index.html#deleteMessagingIntegrationsFacebookIntegrationId.
- id
A key field. Template: Id.
- name
Template: ShortText.
- appId
Template: Id.
- pageId
Template: Id.
- status
Template: ShortText.
- recipient
Template: UriReference.
- dateCreated
Template: DateTime.
- dateModified
Template: DateTime.
- createdBy
Template: UriReference.
- modifiedBy
Template: UriReference.
- version
Data type: DT_I4
- selfUri
Template: ShortText. A read-only field.
- pageAccessToken
Template: ShortText.
- userAccessToken
Template: ShortText.
- appSecret
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/messaging/integrations/line.Documentation: https://developer.mypurecloud.com/api/rest/v2/messaging/index.html#getMessagingIntegrationsLine.
- [Create] action
-
Endpoint URL address:
/messaging/integrations/line.Documentation: https://developer.mypurecloud.com/api/rest/v2/messaging/index.html#postMessagingIntegrationsLine.
- [Update] action
-
Endpoint URL address:
/messaging/integrations/line/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/messaging/index.html#putMessagingIntegrationsLineIntegrationId.
- [Delete] action
-
Endpoint URL address:
/messaging/integrations/line/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/messaging/index.html#deleteMessagingIntegrationsLineIntegrationId.
- id
A key field. Template: Id.
- name
Template: ShortText.
- channelId
Template: Id.
- webhookUri
Template: ShortText.
- status
Template: ShortText.
- recipient
Template: UriReference.
- dateCreated
Template: DateTime.
- dateModified
Template: DateTime.
- createdBy
Template: UriReference.
- modifiedBy
Template: UriReference.
- version
Data type: DT_I4
- selfUri
Template: ShortText. A read-only field.
- channelSecret
Template: ShortText.
- switcherSecret
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/messaging/integrations/twitter.Documentation: https://developer.mypurecloud.com/api/rest/v2/messaging/index.html#getMessagingIntegrationsTwitter.
- [Create] action
-
Endpoint URL address:
/messaging/integrations/twitter.Documentation: https://developer.mypurecloud.com/api/rest/v2/messaging/index.html#postMessagingIntegrationsTwitter.
- [Delete] action
-
Endpoint URL address:
/messaging/integrations/twitter/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/messaging/index.html#deleteMessagingIntegrationsTwitterIntegrationId.
- id
A key field. Template: Id.
- name
Template: ShortText.
- accessTokenKey
Template: ShortText.
- consumerKey
Template: ShortText.
- username
Template: ShortText.
- userId
Template: Id.
- status
Template: ShortText.
- tier
Template: ShortText.
- envName
Template: ShortText.
- recipient
Template: UriReference.
- dateCreated
Template: DateTime.
- dateModified
Template: DateTime.
- createdBy
Template: UriReference.
- modifiedBy
Template: UriReference.
- version
Data type: DT_I4
- selfUri
Template: ShortText. A read-only field.
- accessTokenSecret
Template: ShortText.
- consumerSecret
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/messaging/stickers/{{=parameters.messengerType}}.The action has the following user-defined parameters:
- messengerType: Required. Specify messenger type.
Documentation: https://developer.mypurecloud.com/api/rest/v2/messaging/index.html#getMessagingSticker.
- id
A key field. Template: Id.
- name
Template: ShortText.
- providerStickerId
Data type: DT_I4
- providerPackageId
Data type: DT_I4
- packageName
Template: ShortText.
- messengerType
Template: ShortText.
- stickerType
Template: ShortText.
- providerVersion
Data type: DT_I4
- uriLocation
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/mobiledevices.Documentation: https://developer.mypurecloud.com/api/rest/v2/mobiledevices/index.html#getMobiledevices.
- [Create] action
-
Endpoint URL address:
/mobiledevices.Documentation: https://developer.mypurecloud.com/api/rest/v2/mobiledevices/index.html#postMobiledevices.
- [Update] action
-
Endpoint URL address:
/mobiledevices/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/mobiledevices/index.html#putMobiledevice.
- [Delete] action
-
Endpoint URL address:
/mobiledevices/{{=item.id}}.Documentation: /mobiledevices/{{=item.id}}.
- id
A key field. Template: Id.
- name
Template: ShortText.
- deviceToken
Template: ShortText.
- notificationId
Template: Id.
- make
Template: ShortText.
- model
Template: ShortText.
- acceptNotifications
Data type: DT_BOOL
- type
Template: ShortText.
- sessionHash
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/oauth/clients.Documentation: https://developer.mypurecloud.com/api/rest/v2/oauth/index.html#getOauthClients.
- [Create] action
-
Endpoint URL address:
/oauth/clients.Documentation: https://developer.mypurecloud.com/api/rest/v2/oauth/index.html#postOauthClients.
- [Update] action
-
Endpoint URL address:
/oauth/clients/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/oauth/index.html#putOauthClient.
- [Delete] action
-
Endpoint URL address:
/oauth/clients/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/oauth/index.html#deleteOauthClient.
- id
A key field. Template: Id.
- name
Template: ShortText.
- accessTokenValiditySeconds
Data type: DT_I4
- description
Template: LongText.
- registeredRedirectUri
Template: LongText. A composite field.
- secret
Template: ShortText.
- roleIds
Template: LongText. A composite field.
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- createdBy
Template: UriReference. A read-only field.
- modifiedBy
Template: UriReference. A read-only field.
- scope
Template: LongText. A composite field.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orgauthorization/trustees.Documentation: https://developer.mypurecloud.com/api/rest/v2/organizationauthorization/index.html#getOrgauthorizationTrustees.
- [Create] action
-
Endpoint URL address:
/orgauthorization/trustees.Documentation: https://developer.mypurecloud.com/api/rest/v2/organizationauthorization/index.html#postOrgauthorizationTrustees.
- [Update] action
-
Endpoint URL address:
/orgauthorization/trustees/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/organizationauthorization/index.html#putOrgauthorizationTrustee.
- [Delete] action
-
Endpoint URL address:
/orgauthorization/trustees/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/organizationauthorization/index.html#deleteOrgauthorizationTrustee.
- id
A key field. Template: Id.
- enabled
Data type: DT_BOOL
- dateCreated
Template: DateTime. A read-only field.
- createdBy
Template: User. A read-only field.
- organization
Template: Organization. A read-only field.
- selfUri
Template: ShortText. A read-only field.
- pairingId
Template: Id.
- users
Template: LongText. A composite field.
- groups
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orgauthorization/trustees/{{=parameters.organizationId}}/users.The action has the following user-defined parameters:
- organizationId: Required. Specify organization trustee identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/organizationauthorization/index.html#getOrgauthorizationTrusteeUsers.
- [Create] action
-
Endpoint URL address:
/orgauthorization/trustees/{{=item.organizationId}}/users.Documentation: https://developer.mypurecloud.com/api/rest/v2/organizationauthorization/index.html#postOrgauthorizationTrusteeUsers.
- [Delete] action
-
Endpoint URL address:
/orgauthorization/trustees/{{=item.organizationId}}/users/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/organizationauthorization/index.html#deleteOrgauthorizationTrusteeUser.
The resource includes the fields from the User template.
- organizationId
Template: Id.
- roleIds
Template: LongText. A composite field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orgauthorization/trustors.Documentation: https://developer.mypurecloud.com/api/rest/v2/organizationauthorization/index.html#getOrgauthorizationTrustors.
- [Delete] action
-
Endpoint URL address:
/orgauthorization/trustors/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/organizationauthorization/index.html#deleteOrgauthorizationTrustor.
- id
A key field. Template: Id.
- enabled
Data type: DT_BOOL
- dateCreated
Template: DateTime. A read-only field.
- createdBy
Template: User. A read-only field.
- organization
Template: Organization. A read-only field.
- authorization
Field components:
-
Uses template:
LongText. - Contains the following components: permissions.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orgauthorization/trustors/{{=parameters.organizationId}}/users.The action has the following user-defined parameters:
- organizationId: Required. Specify organization trustor identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/organizationauthorization/index.html#getOrgauthorizationTrustorUsers.
- [Update] action
-
Endpoint URL address:
/orgauthorization/trustors/{{=item.organizationId}}/users/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/organizationauthorization/index.html#putOrgauthorizationTrustorUser.
- [Delete] action
-
Endpoint URL address:
/orgauthorization/trustors/{{=item.organizationId|}/users/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/organizationauthorization/index.html#deleteOrgauthorizationTrustorUser.
The resource includes the fields from the User template.
- organizationId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/outbound/attemptlimits.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundAttemptlimits.
- [Create] action
-
Endpoint URL address:
/outbound/attemptlimits.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#postOutboundAttemptlimits.
- [Update] action
-
Endpoint URL address:
/outbound/attemptlimits/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#putOutboundAttemptlimit.
- [Delete] action
-
Endpoint URL address:
/outbound/attemptlimits/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#deleteOutboundAttemptlimit.
- id
A key field. Template: Id.
- name
Template: ShortText.
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- version
Data type: DT_I4
- maxAttemptsPerContact
Data type: DT_I4
- maxAttemptsPerNumber
Data type: DT_I4
- timeZoneId
Template: Id.
- resetPeriod
Template: ShortText.
- recallEntries
An array field. Field components:
-
Uses template:
Id. - Contains the following components: id, nbrAttempts, minutesBetweenAttempts.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/outbound/audits.
The result is extracted from:{{=response.auditMessages}}.
The action uses POST method.The action has the following user-defined parameters:
- query: Required. Specify query JSON statement.
The following request parameters will be automatically processed:
-
application/json:
{{=JSON.parse(parameters.query)}}
Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#postOutboundAudits.
- id
Template: Id.
- user
Field components:
-
Uses template:
Id. - Contains the following components: id, name, display.
-
Uses template:
- correlationId
Template: Id.
- transactionId
Template: Id.
- transactionInitiator
Data type: DT_BOOL
- application
Template: ShortText.
- serviceName
Template: ShortText.
- level
Template: ShortText.
- timestamp
Template: DateTime.
- receivedTimestamp
Template: DateTime.
- status
Template: ShortText.
- actionContext
Template: ShortText.
- action
Template: ShortText.
- changes
Template: Change. An array field.
- entity
Field components:
-
Uses template:
ShortText. - Contains the following components: type, id, name, selfUri.
-
Uses template:
- serviceContext
Field components:
-
Uses template:
ShortText. - Contains the following components: name.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/outbound/callabletimesets.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundCallabletimesets.
- [Create] action
-
Endpoint URL address:
/outbound/callabletimesets.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#postOutboundCallabletimesets.
- [Update] action
-
Endpoint URL address:
/outbound/callabletimesets/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#putOutboundCallabletimeset.
- [Delete] action
-
Endpoint URL address:
/outbound/callabletimesets/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#deleteOutboundCallabletimeset.
- id
A key field. Template: Id.
- name
Template: ShortText.
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- version
Data type: DT_I4
- callableTimes
An array field. Field components:
-
Uses template:
Id. - Contains the following components: timeSlots, timeZoneId.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/outbound/callanalysisresponsesets.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundCallanalysisresponsesets.
- [Create] action
-
Endpoint URL address:
/outbound/callanalysisresponsesets.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#postOutboundCallanalysisresponsesets.
- [Update] action
-
Endpoint URL address:
/outbound/callanalysisresponsesets/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#putOutboundCallanalysisresponseset.
- [Delete] action
-
Endpoint URL address:
/outbound/callanalysisresponsesets/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#deleteOutboundCallanalysisresponseset.
- id
A key field. Template: Id.
- name
Template: ShortText.
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- version
Data type: DT_I4
- responses
An array field. Field components:
-
Uses template:
Id. - Contains the following components: id, data, name, reactionType.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/outbound/campaignrules.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundCampaignrules.
- [Create] action
-
Endpoint URL address:
/outbound/campaignrules.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#postOutboundCampaignrules.
- [Update] action
-
Endpoint URL address:
/outbound/campaignrules/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#putOutboundCampaignrule.
- [Delete] action
-
Endpoint URL address:
/outbound/campaignrules/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#deleteOutboundCampaignrule.
- id
A key field. Template: Id.
- name
Template: ShortText.
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- version
Data type: DT_I4
- campaignRuleEntities
Template: CampaignRuleEntity.
- campaignRuleConditions
An array field. Field components:
-
Uses template:
Id. - Contains the following components: id, parameters, conditionType.
-
Uses template:
- campaignRuleActions
An array field. Field components:
-
Uses template:
Id. - Contains the following components: id, parameters, actionType, campaignRuleEntities.
-
Uses template:
- matchAnyConditions
Data type: DT_BOOL
- enabled
Data type: DT_BOOL
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/outbound/campaigns.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundCampaigns.
- [Create] action
-
Endpoint URL address:
/outbound/campaigns.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#postOutboundCampaigns.
- [Update] action
-
Endpoint URL address:
/outbound/campaigns/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#putOutboundCampaign.
- [Delete] action
-
Endpoint URL address:
/outbound/campaigns/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#deleteOutboundCampaign.
- id
A key field. Template: Id.
- name
Template: ShortText.
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- version
Data type: DT_I4
- contactList
Template: UriReference.
- queue
Template: UriReference.
- dialingMode
Template: ShortText.
- script
Template: UriReference.
- edgeGroup
Template: UriReference.
- site
Template: UriReference.
- campaignStatus
Template: ShortText.
- phoneColumns
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: columnName, type.
-
Uses template:
- abandonRate
Template: LongText.
- dncLists
Template: UriReference. An array field.
- callableTimeSet
Template: UriReference.
- callAnalysisResponseSet
Template: UriReference.
- errors
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: error, details.
-
Uses template:
- callerName
Template: ShortText.
- callerAddress
Template: ShortText.
- outboundLineCount
Data type: DT_I4
- ruleSets
Template: UriReference. An array field.
- skipPreviewDisabled
Data type: DT_BOOL
- previewTimeOutSeconds
Data type: DT_I4
- alwaysRunning
Data type: DT_BOOL
- contactSort
Template: ContactSort.
- contactSorts
Template: ContactSort. An array field.
- noAnswerTimeout
Data type: DT_I4
- callAnalysisLanguage
Template: ShortText.
- priority
Data type: DT_I4
- contactListFilters
Template: UriReference. An array field.
- selfUri
Template: ShortText. A read-only field.
- diagnostics
-
The value is gathered from
/outbound/campaigns/{{=item.id}}/diagnosticsaddress. Field components:- Contains the following components: callableContacts, queueUtilizationDiagnostic, ruleSetDiagnostics, outstandingInteractionsCount, scheduledInteractionsCount.
Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundCampaignDiagnostics.
- interactions
-
The value is gathered from
/outbound/campaigns/{{=item.id}}/interactionsaddress. Field components:-
Uses template:
UriReference. - Contains the following components: campaign, pendingInteractions, proceedingInteractions, previewingInteractions, interactingInteractions, scheduledInteractions.
Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundCampaignInteractions.
-
Uses template:
- progress
-
The value is gathered from
/outbound/campaigns/{{=item.id}}/progressaddress. Field components:-
Uses template:
UriReference. - Contains the following components: campaign, contactList, numberOfContactsCalled, totalNumberOfContacts, percentage.
Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundCampaignProgress.
-
Uses template:
- stats
-
The value is gathered from
/outbound/campaigns/{{=item.id}}/statsaddress. Field components:-
Uses template:
ShortText. - Contains the following components: contactRate, idleAgents, effectiveIdleAgents, adjustedCallsPerAgent, outstandingCalls, scheduledCalls.
Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundCampaignStats.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/outbound/contactlistfilters.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundContactlistfilters.
- [Create] action
-
Endpoint URL address:
/outbound/contactlistfilters.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#postOutboundContactlistfilters.
- [Update] action
-
Endpoint URL address:
/outbound/contactlistfilters/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#putOutboundContactlistfilter.
- [Delete] action
-
Endpoint URL address:
/outbound/contactlistfilters/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#deleteOutboundContactlistfilter.
- id
A key field. Template: Id.
- name
Template: ShortText.
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- version
Data type: DT_I4
- contactList
Template: UriReference.
- clauses
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: filterType, predicates.
-
Uses template:
- filterType
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/outbound/contactlists.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundContactlists.
- [Create] action
-
Endpoint URL address:
/outbound/contactlists.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#postOutboundContactlists.
- [Update] action
-
Endpoint URL address:
/outbound/contactlists/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#putOutboundContactlist.
- [Delete] action
-
Endpoint URL address:
/outbound/contactlists/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#deleteOutboundContactlist.
- id
A key field. Template: Id.
- name
Template: ShortText.
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- version
Data type: DT_I4
- columnNames
Template: LongText.
- phoneColumns
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: columnName, type, callableTimeColumn.
-
Uses template:
- importStatus
Template: ImportStatus.
- previewModeColumnName
Template: ShortText.
- previewModeAcceptedValues
Template: LongText.
- size
Data type: DT_I4
- attemptLimits
Template: UriReference.
- automaticTimeZoneMapping
Data type: DT_BOOL
- zipCodeColumnName
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/outbound/contactlists/{{=parameters.contactListId}}/contacts/bulk.
The action uses POST method.The action has the following user-defined parameters:
- contactListId: Required. Specify contact list identifier.
- contactIds: Required. Specify comma (,) separated list of contact identifiers.
The following request parameters will be automatically processed:
-
application/json:
{{=parameters.contactIds.split(',')}}
Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#postOutboundContactlistContactsBulk.
- [Create] action
-
Endpoint URL address:
/outbound/contactlists/{{=item.contactListId}}/contacts.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#postOutboundContactlistContacts.
- [Update] action
-
Endpoint URL address:
/outbound/contactlists/{{=item.contactListId}}/contacts/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#putOutboundContactlistContact.
- [Delete] action
-
Endpoint URL address:
/outbound/contactlists/{{=item.contactListId}}/contacts/{{=item.id}}.The following request parameters will be automatically processed:
-
contactIds:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#deleteOutboundContactlistContacts.
-
contactIds:
- id
A key field. Template: Id.
- name
Template: ShortText.
- contactListId
Template: Id.
- data
Template: LongText.
- callRecords
Template: LongText.
- callable
Data type: DT_BOOL
- phoneNumberStatus
Template: LongText.
- contactColumnTimeZones
Template: LongText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/outbound/dnclists.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundDnclists.
- [Create] action
-
Endpoint URL address:
/outbound/dnclists.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#postOutboundDnclists.
- [Update] action
-
Endpoint URL address:
/outbound/dnclists/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#putOutboundDnclist.
- [Delete] action
-
Endpoint URL address:
/outbound/dnclists/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#deleteOutboundDnclist.
- id
A key field. Template: Id.
- name
Template: ShortText.
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- version
Data type: DT_I4
- importStatus
Template: ImportStatus.
- size
Data type: DT_I4
- dncSourceType
Template: ShortText.
- loginId
Template: Id.
- dncCodes
Template: LongText.
- licenseId
Template: Id.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/outbound/events.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundEvents.
- id
A key field. Template: Id.
- name
Template: ShortText.
- errorEntity
Template: UriReference.
- relatedEntity
Template: UriReference.
- timestamp
Template: DateTime.
- level
Template: ShortText.
- category
Template: ShortText.
- correlationId
Template: Id.
- eventMessage
Field components:
-
Uses template:
ShortText. - Contains the following components: code, message, messageWithParams, messageParams, documentationUri, resourceURIs.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/outbound/rulesets.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundRulesets.
- [Create] action
-
Endpoint URL address:
/outbound/rulesets.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#postOutboundRulesets.
- [Update] action
-
Endpoint URL address:
/outbound/rulesets/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#putOutboundRuleset.
- [Delete] action
-
Endpoint URL address:
/outbound/rulesets/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#deleteOutboundRuleset.
- id
A key field. Template: Id.
- name
Template: ShortText.
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- version
Data type: DT_I4
- contactList
Template: UriReference.
- queue
Template: UriReference.
- rules
An array field. Field components:
-
Uses template:
Id. - Contains the following components: id, name, order, category, conditions, actions.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
- [Read] action
-
Endpoint URL address:
/outbound/schedules/campaigns.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundSchedulesCampaigns.
- [Update] action
-
Endpoint URL address:
/outbound/schedules/campaigns/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#putOutboundSchedulesCampaign.
- [Delete] action
-
Endpoint URL address:
/outbound/schedules/campaigns/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#deleteOutboundSchedulesCampaign.
The resource includes the fields from the Schedule template.
- campaign
Template: UriReference.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/outbound/schedules/sequences.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundSchedulesSequences.
- [Update] action
-
Endpoint URL address:
/outbound/schedules/sequences/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#putOutboundSchedulesSequence.
- [Delete] action
-
Endpoint URL address:
/outbound/schedules/sequences/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#deleteOutboundSchedulesSequence.
The resource includes the fields from the Schedule template.
- sequence
Template: UriReference.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/outbound/sequences.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#getOutboundSequences.
- [Create] action
-
Endpoint URL address:
/outbound/sequences.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#postOutboundSequences.
- [Update] action
-
Endpoint URL address:
/outbound/sequences/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#putOutboundSequence.
- [Delete] action
-
Endpoint URL address:
/outbound/sequences/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/outbound/index.html#deleteOutboundSequence.
- id
A key field. Template: Id.
- name
Template: ShortText.
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- version
Data type: DT_I4
- campaigns
Template: UriReference. An array field.
- currentCampaign
Data type: DT_I4
- status
Template: ShortText.
- stopMessage
Template: ShortText.
- repeat
Data type: DT_BOOL
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/presencedefinitions.Documentation: https://developer.mypurecloud.com/api/rest/v2/presence/index.html#getPresencedefinitions.
- [Create] action
-
Endpoint URL address:
/presencedefinitions.Documentation: https://developer.mypurecloud.com/api/rest/v2/presence/index.html#postPresencedefinitions.
- [Update] action
-
Endpoint URL address:
/presencedefinitions/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/presence/index.html#putPresencedefinition.
- [Delete] action
-
Endpoint URL address:
/presencedefinitions/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/presence/index.html#deletePresencedefinition.
- id
A key field. Template: Id.
- name
Template: ShortText.
- languageLabels
Template: LongText.
- systemPresence
Template: ShortText.
- deactivated
Data type: DT_BOOL
- primary
Data type: DT_BOOL
- createdBy
Template: User. A read-only field.
- createdDate
Template: DateTime. A read-only field.
- modifiedBy
Template: User. A read-only field.
- modifiedDate
Template: DateTime. A read-only field.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/quality/agents/activity.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#getQualityAgentsActivity.
- id
A key field. Template: Id.
- name
Template: ShortText.
- agent
Template: User.
- numEvaluations
Data type: DT_I4
- averageEvaluationScore
Data type: DT_I4
- numCriticalEvaluations
Data type: DT_I4
- averageCriticalScore
Template: ShortText.
- highestEvaluationScore
Template: ShortText.
- lowestEvaluationScore
Template: ShortText.
- highestCriticalScore
Template: ShortText.
- lowestCriticalScore
Template: ShortText.
- agentEvaluatorActivityList
An array field. Field components:
-
Uses template:
Id. - Contains the following components: id, name, agent.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/quality/calibrations.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#getQualityCalibrations.
- [Create] action
-
Endpoint URL address:
/quality/calibrations.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#postQualityCalibrations.
- [Update] action
-
Endpoint URL address:
/quality/calibrations/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#putQualityCalibration.
- [Delete] action
-
Endpoint URL address:
/quality/calibrations/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#deleteQualityCalibration.
- id
A key field. Template: Id.
- name
Template: ShortText.
- calibrator
Template: User.
- agent
Template: User.
- conversation
Template: Conversation. Field components:
-
Uses template:
LongText. - Contains the following components: conversationIds, maxParticipants, recordingState, state.
-
Uses template:
- evaluationForm
Template: EvaluationForm.
- contextId
Template: Id.
- averageScore
Data type: DT_I4
- highScore
Data type: DT_I4
- lowScore
Data type: DT_I4
- createdDate
Template: DateTime. A read-only field.
- evaluations
Template: Evaluation. An array field.
- evaluators
Template: User. An array field.
- scoringIndex
Template: Evaluation.
- expertEvaluator
Template: User.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/quality/conversations/{{=parameters.conversationId}}/audits.The action has the following user-defined parameters:
- conversationId: Required. Specify conversation identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#getQualityConversationAudits.
- id
A key field. Template: Id.
- name
Template: ShortText.
- user
Template: User.
- timestamp
Template: DateTime.
- level
Template: ShortText.
- entity
Field components:
-
Uses template:
ShortText. - Contains the following components: type, id, name, selfUri.
-
Uses template:
- action
Template: ShortText.
- status
Template: ShortText.
- changes
Template: Change. An array field.
- entityType
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/quality/evaluations/query.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#getQualityEvaluationsQuery.
- [Create] action
-
Endpoint URL address:
/quality/conversations/{{=item.conversationId}}/evaluations.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#postQualityConversationEvaluations.
- [Update] action
-
Endpoint URL address:
/quality/conversations/{{=item.conversationId}}/evaluations/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#putQualityConversationEvaluation.
- [Delete] action
-
Endpoint URL address:
/quality/conversations/{{=item.conversationId}}/evaluations/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#deleteQualityConversationEvaluation.
The resource includes the fields from the Evaluation template.
- conversationId
A key field. Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/quality/evaluators/activity.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#getQualityEvaluatorsActivity.
- id
Template: Id.
- name
Template: ShortText.
- evaluator
Template: User.
- numEvaluationsAssigned
Data type: DT_I4
- numEvaluationsStarted
Data type: DT_I4
- numEvaluationsCompleted
Data type: DT_I4
- numCalibrationsAssigned
Data type: DT_I4
- numCalibrationsStarted
Data type: DT_I4
- numCalibrationsCompleted
Data type: DT_I4
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/quality/forms/evaluations.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#getQualityFormsEvaluations.
- [Read published] action
-
Endpoint URL address:
/quality/publishedforms/evaluations.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#getQualityPublishedformsEvaluations.
- [Create] action
-
Endpoint URL address:
/quality/forms/evaluations.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#postQualityFormsEvaluations.
- [Update] action
-
Endpoint URL address:
/quality/forms/evaluations/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#putQualityFormsEvaluation.
- [Delete] action
-
Endpoint URL address:
/quality/forms/evaluations/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#deleteQualityFormsEvaluation.
The resource includes the fields from the EvaluationForm template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/quality/forms/surveys.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#getQualityFormsSurveys.
- [Read published] action
-
Endpoint URL address:
/quality/publishedforms/surveys.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#getQualityPublishedformsSurveys.
- [Create] action
-
Endpoint URL address:
/quality/forms/surveys.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#postQualityFormsSurveys.
- [Update] action
-
Endpoint URL address:
/quality/forms/surveys/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#putQualityFormsSurvey.
- [Delete] action
-
Endpoint URL address:
/quality/forms/surveys/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#deleteQualityFormsSurvey.
- id
A key field. Template: Id.
- name
Template: ShortText.
- modifiedDate
Template: DateTime. A read-only field.
- published
Data type: DT_BOOL
- disabled
Data type: DT_BOOL
- contextId
Template: Id.
- language
Template: ShortText.
- headerImageId
Template: Id.
- headerImageUrl
Template: ShortText.
- header
Template: ShortText.
- footer
Template: ShortText.
- questionGroups
An array field. Field components:
-
Uses template:
Id. - Contains the following components: id, name, type, naEnabled, questions, visibilityCondition.
-
Uses template:
- publishedVersions
Template: PublishedVersion.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/quality/keywordsets.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#getQualityKeywordsets.
- [Create] action
-
Endpoint URL address:
/quality/keywordsets.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#postQualityKeywordsets.
- [Update] action
-
Endpoint URL address:
/quality/keywordsets/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#putQualityKeywordset.
- [Delete] action
-
Endpoint URL address:
/quality/keywordsets/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/quality/index.html#deleteQualityKeywordset.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- queues
Template: Queue. An array field.
- language
Template: ShortText.
- agents
Template: User. An array field.
- keywords
An array field. Field components:
-
Uses template:
Id. - Contains the following components: id, name, phrase, confidence, agentScoreModifier, customerScoreModifier, alternateSpellings, pronunciations, antiWords, antiPronunciations, spotabilityIndex, marginOfError, pronunciation.
-
Uses template:
- participantPurposes
Template: LongText.
- selfUri
Template: ShortText. A read-only field.
- [Read] action
-
Endpoint URL address:
/conversations/{{=parameters.conversationId}}/recordings.The action has the following user-defined parameters:
- conversationId: Required. Specify conversation identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/recording/index.html#getConversationRecordings.
The resource includes the fields from the Recording template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/conversations/{{=parameters.conversationId}}/recordings/{{=parameters.recordingId}}/annotations.The action has the following user-defined parameters:
- conversationId: Required. Specify conversation identifier.
- recordingId: Required. Specify recording identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/recording/index.html#putConversationRecording.
- [Create] action
-
Endpoint URL address:
/conversations/{{=item.conversationId}}/recordings/{{=item.recordingId}}/annotations.Documentation: https://developer.mypurecloud.com/api/rest/v2/recording/index.html#postConversationRecordingAnnotations.
- [Update] action
-
Endpoint URL address:
/conversations/{{=itedm.conversationId}}/recordings/{{=item.recordingId}}/annotations/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/recording/index.html#putConversationRecordingAnnotation.
- [Delete] action
-
Endpoint URL address:
/conversations/{{=itedm.conversationId}}/recordings/{{=item.recordingId}}/annotations/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/recording/index.html#deleteConversationRecordingAnnotation.
The resource includes the fields from the Annotation template.
- conversationId
Template: Id.
- recordingId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/orphanrecordings.Documentation: https://developer.mypurecloud.com/api/rest/v2/recording/index.html#getOrphanrecordings.
- [Update] action
-
Endpoint URL address:
/orphanrecordings/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/recording/index.html#putOrphanrecording.
- [Delete] action
-
Endpoint URL address:
/orphanrecordings/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/recording/index.html#deleteOrphanrecording.
- id
A key field. Template: Id.
- name
Template: ShortText.
- createdTime
Template: DateTime. A read-only field.
- recoveredTime
Template: DateTime. A read-only field.
- providerType
Template: ShortText.
- mediaSizeBytes
Data type: DT_I4
- mediaType
Template: ShortText.
- fileState
Template: ShortText.
- providerEndpoint
Template: EndPoint.
- recording
Template: Recording.
- orphanStatus
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/recording/mediaretentionpolicies.Documentation: https://developer.mypurecloud.com/api/rest/v2/recording/index.html#getRecordingMediaretentionpolicies.
- [Create] action
-
Endpoint URL address:
/recording/mediaretentionpolicies.Documentation: https://developer.mypurecloud.com/api/rest/v2/recording/index.html#postRecordingMediaretentionpolicies.
- [Update] action
-
Endpoint URL address:
/recording/mediaretentionpolicies/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/recording/index.html#putRecordingMediaretentionpolicy.
- [Delete] action
-
Endpoint URL address:
/recording/mediaretentionpolicies.The following request parameters will be automatically processed:
-
ids:
{{=_.pluck(batch, 'id').join()}}
Documentation: https://developer.mypurecloud.com/api/rest/v2/recording/index.html#deleteRecordingMediaretentionpolicies.
-
ids:
- id
A key field. Template: Id.
- name
Template: ShortText.
- modifiedDate
Template: DateTime. A read-only field.
- createdDate
Template: DateTime. A read-only field.
- order
Data type: DT_I4
- description
Template: LongText.
- enabled
Data type: DT_BOOL
- mediaPolicies
Field components:
-
Uses template:
MediaPolicy. - Contains the following components: callPolicy, chatPolicy, emailPolicy, messagePolicy.
-
Uses template:
- conditions
Field components:
-
Uses template:
User. - Contains the following components: forUsers, directions, dateRanges, mediaTypes, forQueues, duration, wrapupCodes, timeAllowed.
-
Uses template:
- actions
Field components:
- Contains the following components: retainRecording, deleteRecording, alwaysDelete, assignEvaluations, assignMeteredEvaluations, assignCalibrations, assignSurveys, retentionDuration, initiateScreenRecording, mediaTranscriptions.
- policyErrors
Field components:
- An array.
- Contains the following components: statusCode, userMessage, userParamsMessage, errorCode, correlationId, userParams, insertDate.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/recording/recordingkeys.Documentation: https://developer.mypurecloud.com/api/rest/v2/recording/index.html#getRecordingRecordingkeys.
- [Create] action
-
Endpoint URL address:
/recording/recordingkeys.Documentation: https://developer.mypurecloud.com/api/rest/v2/recording/index.html#postRecordingRecordingkeys.
- id
A key field. Template: Id.
- name
Template: ShortText.
- createDate
Template: DateTime. A read-only field.
- keydataSummary
Template: ShortText.
- user
Template: User.
- localEncryptionConfiguration
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, url, apiId, apiKey, selfUri.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/responsemanagement/libraries.Documentation: https://developer.mypurecloud.com/api/rest/v2/responsemanagement/index.html#getResponsemanagementLibraries.
- [Create] action
-
Endpoint URL address:
/responsemanagement/libraries.Documentation: https://developer.mypurecloud.com/api/rest/v2/responsemanagement/index.html#postResponsemanagementLibraries.
- [Update] action
-
Endpoint URL address:
/responsemanagement/libraries/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/responsemanagement/index.html#putResponsemanagementLibrary.
- [Delete] action
-
Endpoint URL address:
/responsemanagement/libraries/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/responsemanagement/index.html#deleteResponsemanagementLibrary.
- id
A key field. Template: Id.
- name
Template: ShortText.
- version
Data type: DT_I4
- createdBy
Template: User. A read-only field.
- dateCreated
Template: DateTime. A read-only field.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/responsemanagement/responses.Documentation: https://developer.mypurecloud.com/api/rest/v2/responsemanagement/index.html#getResponsemanagementResponses.
- [Read query] action
-
Endpoint URL address:
/responsemanagement/responses/query.
The result is extracted from:{{=response.results.entities}}.
The action uses POST method.
The result is paginated.The action has the following user-defined parameters:
- queryPhrase: Specify query phrase to search response text and name.
The following request parameters will be automatically processed:
-
application/json:
{{={ queryPhrase: parameters.get('queryPhrase'), pageSize: parameters.batchSize } }}
Documentation: https://developer.mypurecloud.com/api/rest/v2/responsemanagement/index.html#postResponsemanagementResponsesQuery.
- [Create] action
-
Endpoint URL address:
/responsemanagement/responses.Documentation: https://developer.mypurecloud.com/api/rest/v2/responsemanagement/index.html#postResponsemanagementResponses.
- [Update] action
-
Endpoint URL address:
/responsemanagement/responses/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/responsemanagement/index.html#putResponsemanagementResponse.
- [Delete] action
-
Endpoint URL address:
/responsemanagement/responses/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/responsemanagement/index.html#deleteResponsemanagementResponse.
- id
A key field. Template: Id.
- name
Template: ShortText.
- version
Data type: DT_I4
- libraries
Template: UriReference. An array field.
- texts
An array field. Field components:
-
Uses template:
LongText. - Contains the following components: content, contentType.
-
Uses template:
- createdBy
Template: User. A read-only field.
- dateCreated
Template: DateTime. A read-only field.
- interactionType
Template: ShortText.
- substitutions
An array field. Field components:
-
Uses template:
Id. - Contains the following components: id, description, defaultValue.
-
Uses template:
- substitutionsSchema
Field components:
-
Uses template:
Id. - Contains the following components: id, $schema, title, description, type, required, properties, additionalProperties.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/routing/email/domains.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#getRoutingEmailDomains.
- [Create] action
-
Endpoint URL address:
/routing/email/domains.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#postRoutingEmailDomains.
- [Delete] action
-
Endpoint URL address:
/routing/email/domains/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#deleteRoutingEmailDomain.
- id
A key field. Template: Id.
- name
Template: ShortText.
- mxRecordStatus
Template: ShortText.
- subDomain
Data type: DT_BOOL
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/routing/email/domains/{{=parameters.domainName}}/routes.The action has the following user-defined parameters:
- domainName: Required. Specify domain name.
Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#getRoutingEmailDomainRoutes.
- [Create] action
-
Endpoint URL address:
/routing/email/domains/{{=item.domainName}}/routes.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#postRoutingEmailDomainRoutes.
- [Update] action
-
Endpoint URL address:
/routing/email/domains/{{=item.domainName}}/routes/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#putRoutingEmailDomainRoute.
- [Delete] action
-
Endpoint URL address:
/routing/email/domains/{{=item.domainName}}/routes/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#deleteRoutingEmailDomainRoute.
- id
A key field. Template: Id.
- name
Template: ShortText.
- pattern
Template: ShortText.
- queue
Template: UriReference.
- priority
Data type: DT_I4
- skills
Template: UriReference. An array field.
- language
Template: UriReference.
- fromName
Template: ShortText.
- fromEmail
Template: ShortText.
- flow
Template: UriReference.
- replyEmailAddress
Field components:
-
Uses template:
UriReference. - Contains the following components: domain, route.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
- domainName
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/routing/languages.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#getRoutingLanguages.
- [Create] action
-
Endpoint URL address:
/routing/languages.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#postRoutingLanguages.
- id
A key field. Template: Id.
- name
Template: ShortText.
- dateModified
Template: DateTime.
- state
Template: ShortText.
- version
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/routing/message/recipients.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#getRoutingMessageRecipients.
- [Update] action
-
Endpoint URL address:
/routing/message/recipients/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#putRoutingMessageRecipient.
- id
A key field. Template: Id.
- name
Template: ShortText.
- flow
Template: Flow.
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- createdBy
Template: User. A read-only field.
- modifiedBy
Template: User. A read-only field.
- messengerType
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/routing/queues.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#getRoutingQueues.
- [Create] action
-
Endpoint URL address:
/routing/queues.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#postRoutingQueues.
- [Update] action
-
Endpoint URL address:
/routing/queues/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#putRoutingQueue.
- [Delete] action
-
Endpoint URL address:
/routing/queues/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#deleteRoutingQueue.
The resource includes the fields from the Queue template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/routing/queues/{{=parameters.queueId}}/users.The action has the following user-defined parameters:
- queueId: Required. Specify queue identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#getRoutingQueueUsers.
- [Create] action
-
Endpoint URL address:
/routing/queues/{{=parameters.queueId}}/users.The action has the following user-defined parameters:
- queueId: Required. Specify queue identifier.
The following request parameters will be automatically processed:
-
application/json:
{{=_.map(batch, function(item) { return { id: item.user.id }; })}}
Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#postRoutingQueueUsers.
- [Delete] action
-
Endpoint URL address:
/routing/queues/{{=parameters.queueId}}/users.The action has the following user-defined parameters:
- queueId: Required. Specify queue identifier.
The following request parameters will be automatically processed:
-
delete:
true -
application/json:
{{=_.map(batch, function(item) { return { id: item.user.id }; })}}
Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#postRoutingQueueUsers.
- id
A key field. Template: Id.
- name
Template: ShortText.
- user
Template: User.
- ringNumber
Data type: DT_I4
- joined
Data type: DT_BOOL
- memberBy
Template: ShortText.
- routingStatus
Template: RoutingStatus.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/routing/queues/{{=parameters.queueId}}/wrapupcodes.The action has the following user-defined parameters:
- queueId: Required. Specify queue identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#getRoutingQueueWrapupcodes.
- [Create] action
-
Endpoint URL address:
/routing/queues/{{=parameters.queueId}}/wrapupcodes.The action has the following user-defined parameters:
- queueId: Required. Specify queue identifier.
The following request parameters will be automatically processed:
-
application/json:
{{=_.map(batch, function(item) { return { id: item.wrapupCodeId }; })}}
Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#postRoutingQueueWrapupcodes.
- [Delete] action
-
Endpoint URL address:
/routing/queues/{{=parameters.queueId}}/wrapupcodes/{{=item.wrapupCodeId}}.The action has the following user-defined parameters:
- queueId: Required. Specify queue identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#deleteRoutingQueueWrapupcode.
The resource includes the fields from the WrapupCode template.
- wrapupCodeId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/routing/skills.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#getRoutingSkills.
- [Create] action
-
Endpoint URL address:
/routing/skills.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#postRoutingSkills.
- [Delete] action
-
Endpoint URL address:
/routing/skills/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#deleteRoutingSkill.
- id
A key field. Template: Id.
- name
Template: ShortText.
- dateModified
Template: DateTime. A read-only field.
- state
Template: ShortText. A read-only field.
- version
Template: ShortText. A read-only field.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read available] action
-
Endpoint URL address:
/routing/sms/availablephonenumbers.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#getRoutingSmsAvailablephonenumbers.
- [Read provisioned] action
-
Endpoint URL address:
/routing/sms/phonenumbers.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#getRoutingSmsPhonenumbers.
- [Create] action
-
Endpoint URL address:
/routing/sms/phonenumbers.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#postRoutingSmsPhonenumbers.
- [Update] action
-
Endpoint URL address:
/routing/sms/phonenumbers/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#putRoutingSmsPhonenumber.
- [Delete] action
-
Endpoint URL address:
/routing/sms/phonenumbers/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#deleteRoutingSmsPhonenumber.
- id
A key field. Template: Id.
- name
Template: ShortText.
- phoneNumber
Template: ShortText.
- phoneNumberType
Template: ShortText.
- provisionedThroughPureCloud
Data type: DT_BOOL
- phoneNumberStatus
Template: ShortText.
- countryCode
Template: ShortText.
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- createdBy
Template: User. A read-only field.
- modifiedBy
Template: User. A read-only field.
- version
Data type: DT_I4
- selfUri
Template: ShortText. A read-only field.
- region
Template: ShortText.
- city
Template: ShortText.
- capabilities
Template: LongText.
- addressRequirement
Template: ShortText.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/routing/wrapupcodes.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#getRoutingWrapupcodes.
- [Create] action
-
Endpoint URL address:
/routing/wrapupcodes.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#postRoutingWrapupcodes.
- [Update] action
-
Endpoint URL address:
/routing/wrapupcodes/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#putRoutingWrapupcode.
- [Delete] action
-
Endpoint URL address:
/routing/wrapupcodes/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#deleteRoutingWrapupcode.
The resource includes the fields from the WrapupCode template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/routinglanguages.The action has the following user-defined parameters:
- userId: Required. Specify user identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#getUserRoutinglanguages.
- [Create] action
-
Endpoint URL address:
/users/{{=item.userId}}/routinglanguages.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#postUserRoutinglanguages.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.userId}}/routinglanguages.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#deleteUserRoutinglanguage.
The resource includes the fields from the Language template.
- userId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/routingskills.The action has the following user-defined parameters:
- userId: Required. Specify user identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#getUserRoutingskills.
- [Create] action
-
Endpoint URL address:
/users/{{=item.userId}}/routingskills.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#postUserRoutingskills.
- [Update] action
-
Endpoint URL address:
/users/{{=item.userId}}/routingskills/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#putUserRoutingskill.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.userId}}/routingskills/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/routing/index.html#deleteUserRoutingskill.
The resource includes the fields from the Skill template.
- userId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/scripts.Documentation: https://developer.mypurecloud.com/api/rest/v2/scripts/index.html#getScripts.
- [Read published] action
-
Endpoint URL address:
/scripts/published.Documentation: https://developer.mypurecloud.com/api/rest/v2/scripts/index.html#getScriptsPublished.
- id
A key field. Template: Id.
- name
Template: ShortText.
- versionId
Template: Id.
- createdDate
Template: DateTime.
- modifiedDate
Template: DateTime.
- publishedDate
Template: DateTime.
- versionDate
Template: DateTime.
- startPageId
Template: Id.
- startPageName
Template: ShortText.
- features
Template: LongText.
- variables
Template: LongText.
- customActions
Template: LongText.
- pages
-
An array field. The value is gathered from
/scripts/{{=item.id}}/pagesaddress. Field components:-
Uses template:
Id. - Contains the following components: id, name, versionId, createdDate, modifiedDate, rootContainer, properties, selfUri.
Documentation: https://developer.mypurecloud.com/api/rest/v2/scripts/index.html#getScriptPages.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/stations.Documentation: https://developer.mypurecloud.com/api/rest/v2/stations/index.html#getStations.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- status
Template: ShortText.
- userId
Template: Id.
- webRtcUserId
Template: Id.
- primaryEdge
Template: UriReference.
- secondaryEdge
Template: UriReference.
- type
Template: ShortText.
- lineAppearanceId
Template: Id.
- webRtcMediaDscp
Template: ShortText.
- webRtcPersistentEnabled
Data type: DT_BOOL
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdges.
- [Create] action
-
Endpoint URL address:
/telephony/providers/edges.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#postTelephonyProvidersEdges.
- [Update] action
-
Endpoint URL address:
/telephony/providers/edges/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#putTelephonyProvidersEdge.
- [Delete] action
-
Endpoint URL address:
/telephony/providers/edges/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#deleteTelephonyProvidersEdge.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText. A read-only field.
- createdByApp
Template: ShortText. A read-only field.
- interfaces
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: type, ipAddress, name, macAddress, ifName, endpoints, lineTypes, addressFamilyId.
-
Uses template:
- make
Template: ShortText.
- model
Template: ShortText.
- apiVersion
Template: ShortText.
- softwareVersion
Template: ShortText.
- softwareVersionTimestamp
Template: DateTime.
- softwareVersionPlatform
Template: ShortText.
- softwareVersionConfiguration
Template: ShortText.
- fullSoftwareVersion
Template: ShortText.
- pairingId
Template: Id.
- fingerprint
Template: ShortText.
- fingerprintHint
Template: ShortText.
- currentVersion
Template: ShortText.
- stagedVersion
Template: ShortText.
- patch
Template: ShortText.
- statusCode
Template: ShortText.
- edgeGroup
Template: EdgeGroup.
- site
Template: Site.
- softwareStatus
Template: SoftwareStatus.
- onlineStatus
Template: ShortText.
- serialNumber
Template: ShortText.
- physicalEdge
Data type: DT_BOOL
- managed
Data type: DT_BOOL
- edgeDeploymentType
Template: ShortText.
- callDrainingState
Template: ShortText.
- conversationCount
Data type: DT_I4
- proxy
Template: ShortText.
- offlineConfigCalled
Data type: DT_BOOL
- osName
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
- metrics
-
The value is gathered from
/telephony/providers/edges/{{=item.id}}/metricsaddress. Field components:-
Uses template:
UriReference. - Contains the following components: edge, eventTime, upTimeMsec, processors, memory, disks, subsystems, networks.
Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgeMetrics.
-
Uses template:
- softwareversions
-
An array field. The value is gathered from
/telephony/providers/edges/{{=item.id}}/softwareversionsaddress. The gathered value is processed with{{=response.entities}}expression. Field components:-
Uses template:
Id. - Contains the following components: id, name, edgeVersion, publishDate, edgeUri, latestRelease, current, selfUri.
Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgeSoftwareversions.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/{{=parameters.edgeId}}/lines.The action has the following user-defined parameters:
- edgeId: Required. Specify edge identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgeLines.
- [Update] action
-
Endpoint URL address:
/telephony/providers/edges/{{=item.edgeId}}/lines/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#putTelephonyProvidersEdgeLine.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText. A read-only field.
- createdByApp
Template: ShortText. A read-only field.
- schema
Template: UriReference.
- properties
Template: LongText.
- edge
Template: Edge.
- edgeGroup
Template: EdgeGroup.
- lineType
Template: ShortText.
- endpoint
Template: EndPoint.
- ipAddress
Template: ShortText.
- logicalInterfaceId
Template: Id.
- selfUri
Template: ShortText. A read-only field.
- edgeId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/logicalinterfaces.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesLogicalinterfaces.
- [Read edge] action
-
Endpoint URL address:
/telephony/providers/edges/{{=parameters.edgeId}}/logicalinterfaces.The action has the following user-defined parameters:
- edgeId: Required. Specify edge identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgeLogicalinterfaces.
- [Create] action
-
Endpoint URL address:
/telephony/providers/edges/{{=item.edgeId}}/logicalinterfaces.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#postTelephonyProvidersEdgeLogicalinterfaces.
- [Update] action
-
Endpoint URL address:
/telephony/providers/edges/{{=item.edgeId}}/logicalinterfaces/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#putTelephonyProvidersEdgeLogicalinterface.
- [Delete] action
-
Endpoint URL address:
/telephony/providers/edges/{{=item.edgeId}}/logicalinterfaces/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#deleteTelephonyProvidersEdgeLogicalinterface.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText. A read-only field.
- createdByApp
Template: ShortText. A read-only field.
- edgeUri
Template: ShortText.
- edgeAssignedId
Template: Id.
- friendlyName
Template: ShortText.
- vlanTagId
Template: Id.
- hardwareAddress
Template: ShortText.
- physicalAdapterId
Template: Id.
- ifStatus
Template: ShortText.
- interfaceType
Template: ShortText.
- routes
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: prefix, nexthop, persistent, metric, family.
-
Uses template:
- addresses
Template: IpAddress. An array field.
- ipv4Capabilities
Field components:
- Contains the following components: enabled, dhcp, metric, autoMetric, supportsMetric, pingEnabled.
- ipv6Capabilities
Field components:
- Contains the following components: enabled, dhcp, metric, autoMetric, supportsMetric, pingEnabled.
- currentState
Template: ShortText.
- lastModifiedUserId
Template: Id. A read-only field.
- lastModifiedCorrelationId
Template: Id. A read-only field.
- commandResponses
An array field. Field components:
-
Uses template:
Id. - Contains the following components: correlationId, commandName, acknowledged, errorInfo.
-
Uses template:
- inheritPhoneTrunkBasesIPv4
Data type: DT_BOOL
- inheritPhoneTrunkBasesIPv6
Data type: DT_BOOL
- useForInternalEdgeCommunication
Data type: DT_BOOL
- externalTrunkBaseAssignments
An array field. Field components:
-
Uses template:
TrunkBase. - Contains the following components: family, trunkBase.
-
Uses template:
- phoneTrunkBaseAssignments
An array field. Field components:
-
Uses template:
TrunkBase. - Contains the following components: family, trunkBase.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
- edgeId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/physicalinterfaces.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesPhysicalinterfaces.
- [Read edge] action
-
Endpoint URL address:
/telephony/providers/edges/{{=parameters.edgeId}}/physicalinterfaces.The action has the following user-defined parameters:
- edgeId: Required. Specify edge identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgePhysicalinterfaces.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText. A read-only field.
- createdByApp
Template: ShortText. A read-only field.
- edgeUri
Template: ShortText.
- friendlyName
Template: ShortText.
- hardwareAddress
Template: ShortText.
- portLabel
Template: ShortText.
- physicalCapabilities
Field components:
- Contains the following components: vlan, team.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/trunks.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesTrunks.
- [Read edge] action
-
Endpoint URL address:
/telephony/providers/edges/{{=parameters.edgeId}}/trunks.The action has the following user-defined parameters:
- edgeId: Required. Specify edge identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgeTrunks.
- id
Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText. A read-only field.
- createdByApp
Template: ShortText. A read-only field.
- trunkType
Template: ShortText.
- edge
Template: UriReference.
- trunkBase
Template: UriReference.
- trunkMetabase
Template: UriReference.
- edgeGroup
Template: UriReference.
- inService
Data type: DT_BOOL
- enabled
Data type: DT_BOOL
- selfUri
Template: ShortText. A read-only field.
- metrics
-
The value is gathered from
/telephony/providers/edges/trunks/metricsaddress. The gathered value is processed with{{=response[0]}}expression. Field components:-
Uses template:
DateTime. - Contains the following components: eventTime, logicalInterface, trunk, calls, qos.
Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesTrunksMetrics.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/certificateauthorities.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesCertificateauthorities.
- [Create] action
-
Endpoint URL address:
/telephony/providers/edges/certificateauthorities.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#postTelephonyProvidersEdgesCertificateauthorities.
- [Update] action
-
Endpoint URL address:
/telephony/providers/edges/certificateauthorities/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#putTelephonyProvidersEdgesCertificateauthority.
- [Delete] action
-
Endpoint URL address:
/telephony/providers/edges/certificateauthorities/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#deleteTelephonyProvidersEdgesCertificateauthority.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText. A read-only field.
- createdByApp
Template: ShortText. A read-only field.
- certificate
Template: ShortText.
- type
Template: ShortText.
- services
Template: LongText.
- certificateDetails
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: issuer, subject, expirationDate, issueDate, expired, signatureValid, valid.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/didpools.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesDidpools.
- [Create] action
-
Endpoint URL address:
/telephony/providers/edges/didpools.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#postTelephonyProvidersEdgesDidpools.
- [Update] action
-
Endpoint URL address:
/telephony/providers/edges/didpools/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#putTelephonyProvidersEdgesDidpool.
- [Delete] action
-
Endpoint URL address:
/telephony/providers/edges/didpools/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#deleteTelephonyProvidersEdgesDidpool.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText. A read-only field.
- createdByApp
Template: ShortText. A read-only field.
- startPhoneNumber
Template: ShortText.
- endPhoneNumber
Template: ShortText.
- comments
Template: ShortText.
- provider
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/dids.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesDids.
- [Update] action
-
Endpoint URL address:
/telephony/providers/edges/dids/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#putTelephonyProvidersEdgesDid.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText. A read-only field.
- createdByApp
Template: ShortText. A read-only field.
- phoneNumber
Template: ShortText.
- didPool
Template: UriReference.
- owner
Template: UriReference.
- ownerType
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/edgegroups.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesEdgegroups.
- [Create] action
-
Endpoint URL address:
/telephony/providers/edges/edgegroups.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#postTelephonyProvidersEdgesEdgegroups.
- [Update] action
-
Endpoint URL address:
/telephony/providers/edges/edgegroups/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#postTelephonyProvidersEdgesEdgegroups.
- [Delete] action
-
Endpoint URL address:
/telephony/providers/edges/edgegroups/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#deleteTelephonyProvidersEdgesEdgegroup.
The resource includes the fields from the EdgeGroup template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/endpoints.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesEndpoints.
- [Create] action
-
Endpoint URL address:
/telephony/providers/edges/endpoints.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#postTelephonyProvidersEdgesEndpoints.
- [Update] action
-
Endpoint URL address:
/telephony/providers/edges/endpoints/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#putTelephonyProvidersEdgesEndpoint.
- [Delete] action
-
Endpoint URL address:
/telephony/providers/edges/endpoints/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#deleteTelephonyProvidersEdgesEndpoint.
The resource includes the fields from the EndPoint template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/extensionpools.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesExtensionpools.
- [Create] action
-
Endpoint URL address:
/telephony/providers/edges/extensionpools.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#postTelephonyProvidersEdgesExtensionpools.
- [Update] action
-
Endpoint URL address:
/telephony/providers/edges/extensionpools/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#putTelephonyProvidersEdgesExtensionpool.
- [Delete] action
-
Endpoint URL address:
/telephony/providers/edges/extensionpools/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#deleteTelephonyProvidersEdgesExtensionpool.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText. A read-only field.
- createdByApp
Template: ShortText. A read-only field.
- startNumber
Template: ShortText.
- endNumber
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/extensions.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesExtensions.
- [Update] action
-
Endpoint URL address:
/telephony/providers/edges/extensions/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#putTelephonyProvidersEdgesExtension.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText. A read-only field.
- createdByApp
Template: ShortText. A read-only field.
- number
Template: ShortText.
- owner
Template: UriReference.
- extensionPool
Template: UriReference.
- ownerType
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/linebasesettings.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesLinebasesettings.
The resource includes the fields from the LineBaseSetting template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/lines.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesLines.
The resource includes the fields from the Line template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/outboundroutes.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesOutboundroutes.
- [Read site] action
-
Endpoint URL address:
/telephony/providers/edges/sites/{{=parameters.siteId}}/outboundroutes.The action has the following user-defined parameters:
- siteId: Required. Specify site identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesSiteOutboundroutes.
- [Create] action
-
Endpoint URL address:
/telephony/providers/edges/sites/{{=item.siteId}}/outboundroutes.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#postTelephonyProvidersEdgesSiteOutboundroutes.
- [Update] action
-
Endpoint URL address:
/telephony/providers/edges/sites/{{=item.siteId}}/outboundroutes/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#putTelephonyProvidersEdgesSiteOutboundroute.
- [Delete] action
-
Endpoint URL address:
/telephony/providers/edges/sites/{{=item.siteId}}/outboundroutes/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#deleteTelephonyProvidersEdgesSiteOutboundroute.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText. A read-only field.
- createdByApp
Template: ShortText. A read-only field.
- classificationTypes
Template: LongText.
- enabled
Data type: DT_BOOL
- distribution
Template: ShortText.
- externalTrunkBases
Template: UriReference. An array field.
- site
Template: Site.
- managed
Data type: DT_BOOL
- selfUri
Template: ShortText. A read-only field.
- siteId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/phonebasesettings.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesPhonebasesettings.
- [Create] action
-
Endpoint URL address:
/telephony/providers/edges/phonebasesettings.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#postTelephonyProvidersEdgesPhonebasesettings.
- [Update] action
-
Endpoint URL address:
/telephony/providers/edges/phonebasesettings/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#putTelephonyProvidersEdgesPhonebasesetting.
- [Delete] action
-
Endpoint URL address:
/telephony/providers/edges/phonebasesettings/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#deleteTelephonyProvidersEdgesPhonebasesetting.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText. A read-only field.
- createdByApp
Template: ShortText. A read-only field.
- phoneMetaBase
Template: UriReference.
- lines
Template: LineBaseSetting. An array field.
- properties
Template: LongText.
- capabilities
Template: Capabilities.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/phonebasesettings/availablemetabases.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesPhonebasesettingsAvailablemetabases.
The resource includes the fields from the MetaBase template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/phones.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesPhones.
- [Create] action
-
Endpoint URL address:
/telephony/providers/edges/phones.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#postTelephonyProvidersEdgesPhones.
- [Update] action
-
Endpoint URL address:
/telephony/providers/edges/phones/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#putTelephonyProvidersEdgesPhone.
- [Delete] action
-
Endpoint URL address:
/telephony/providers/edges/phones/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#deleteTelephonyProvidersEdgesPhone.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText. A read-only field.
- createdByApp
Template: ShortText. A read-only field.
- site
Template: UriReference.
- phoneBaseSettings
Template: UriReference.
- lineBaseSettings
Template: UriReference.
- phoneMetaBase
Template: UriReference.
- lines
Template: Line. An array field.
- status
Template: Status.
- secondaryStatus
Template: Status.
- userAgentInfo
Field components:
-
Uses template:
ShortText. - Contains the following components: firmwareVersion, manufacturer, model.
-
Uses template:
- properties
Template: LongText.
- capabilities
Template: Capabilities.
- webRtcUser
Template: UriReference.
- primaryEdge
Template: Edge.
- secondaryEdge
Template: Edge.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/sites.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesSites.
- [Create] action
-
Endpoint URL address:
/telephony/providers/edges/sites.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#postTelephonyProvidersEdgesSites.
- [Update] action
-
Endpoint URL address:
/telephony/providers/edges/sites/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#putTelephonyProvidersEdgesSite.
- [Delete] action
-
Endpoint URL address:
/telephony/providers/edges/sites/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#deleteTelephonyProvidersEdgesSite.
The resource includes the fields from the Site template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/sites/{{=parameters.siteId}}/numberplans.The action has the following user-defined parameters:
- siteId: Required. Specify site identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesSiteNumberplans.
- [Update] action
-
Endpoint URL address:
/telephony/providers/edges/sites/{{=item.siteId}}/numberplans.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#putTelephonyProvidersEdgesSiteNumberplans.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- version
Data type: DT_I4
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- modifiedBy
Template: ShortText. A read-only field.
- createdBy
Template: ShortText. A read-only field.
- state
Template: ShortText.
- modifiedByApp
Template: ShortText. A read-only field.
- createdByApp
Template: ShortText. A read-only field.
- match
Template: ShortText.
- normalizedFormat
Template: ShortText.
- priority
Data type: DT_I4
- numbers
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: start, end.
-
Uses template:
- digitLength
Field components:
-
Uses template:
ShortText. - Contains the following components: start, end.
-
Uses template:
- classification
Template: ShortText.
- matchType
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
- siteId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/trunkbasesettings.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesTrunkbasesettings.
- [Create] action
-
Endpoint URL address:
/telephony/providers/edges/trunkbasesettings.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#postTelephonyProvidersEdgesTrunkbasesettings.
- [Update] action
-
Endpoint URL address:
/telephony/providers/edges/trunkbasesettings/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#putTelephonyProvidersEdgesTrunkbasesetting.
- [Delete] action
-
Endpoint URL address:
/telephony/providers/edges/trunkbasesettings/{{=item.id}}.
The resource includes the fields from the TrunkBase template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/telephony/providers/edges/trunkbasesettings/availablemetabases.Documentation: https://developer.mypurecloud.com/api/rest/v2/telephonyprovidersedge/index.html#getTelephonyProvidersEdgesTrunkbasesettingsAvailablemetabases.
The resource includes the fields from the MetaBase template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/userrecordings.Documentation: https://developer.mypurecloud.com/api/rest/v2/userrecordings/index.html#getUserrecordings.
- [Update] action
-
Endpoint URL address:
/userrecordings/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/userrecordings/index.html#putUserrecording.
- [Delete] action
-
Endpoint URL address:
/userrecordings/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/userrecordings/index.html#deleteUserrecording.
- id
A key field. Template: Id.
- name
Template: ShortText.
- dateCreated
Template: DateTime. A read-only field.
- dateModified
Template: DateTime. A read-only field.
- contentUri
Template: ShortText.
- workspace
Template: UriReference.
- createdBy
Template: UriReference.
- conversation
Template: Conversation. Field components:
-
Uses template:
LongText. - Contains the following components: conversationIds, maxParticipants, recordingState, state.
-
Uses template:
- contentLength
Data type: DT_I4 A read-only field.
- durationMilliseconds
Data type: DT_I4 A read-only field.
- thumbnails
Template: Image. An array field.
- read
Data type: DT_BOOL
- selfUri
Template: ShortText. A read-only field.
- media
Data type: DT_IMAGE The value is gathered from
/userrecordings/{{=item.id}}/mediaaddress. The gathered value is processed with{{=connection.execute({ url: response.contentLocationUri })}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/profiles/users.Documentation: https://developer.mypurecloud.com/api/rest/v2/users/index.html#getProfilesUsers.
The resource includes the fields from the UserProfile template.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users.Documentation: https://developer.mypurecloud.com/api/rest/v2/users/index.html#getUsers.
- [Read managementUnit] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=parameters.managementUnitId}}/users.The action has the following user-defined parameters:
- managementUnitId: Required. Specify management unit identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#getWorkforcemanagementManagementunitUsers.
- [Read search] action
-
Endpoint URL address:
/users/search.
The result is extracted from:{{=response.results}}.
The action uses POST method.
The result is paginated.The action has the following user-defined parameters:
- query: Specify query JSON statement.
The following request parameters will be automatically processed:
-
application/json:
{{=_.extend( { paging: { pageNumber: parameters.iterator, pageSize: parameters.batchSize } }, parameters.get('query') && JSON.parse(parameters.query) )}}
Documentation: https://developer.mypurecloud.com/api/rest/v2/users/index.html#postUsersSearch.
- [Create] action
-
Endpoint URL address:
/users.Documentation: https://developer.mypurecloud.com/api/rest/v2/users/index.html#postUsers.
- [Update] action
-
Endpoint URL address:
/users/{{=item.id}}.
The action uses PATCH method.Documentation: https://developer.mypurecloud.com/api/rest/v2/users/index.html#patchUser.
- [Delete] action
-
Endpoint URL address:
/users/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/users/index.html#deleteUser.
The resource includes the fields from the User template.
- manager
Template: User.
- adjacents
-
The value is gathered from
/users/{{=item.id}}/adjacentsaddress. Field components:-
Uses template:
User. - Contains the following components: superiors, siblings, directReports.
Documentation: https://developer.mypurecloud.com/api/rest/v2/users/index.html#getUserAdjacents.
-
Uses template:
- callforwarding
The value is gathered from
/users/{{=item.id}}/callforwardingaddress. The value is sent to/users/{{{=item.id}}/callforwardingaddress. Field components:-
Uses template:
Id. - Contains the following components: id, name, user, enabled, phoneNumber, calls, voicemail, modifiedDate, selfUri.
-
Uses template:
- profile
Template: UserProfile. The value is gathered from
/users/{{=item.id}}/profileaddress.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/users/{{=parameters.userId}}/trustors.The action has the following user-defined parameters:
- userId: Required. Specify user identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/users/index.html#getUserTrustors.
- id
A key field. Template: Id.
- enabled
Data type: DT_BOOL
- dateCreated
Template: DateTime. A read-only field.
- createdBy
Template: User.
- organization
Template: Organization.
- authorization
Field components:
-
Uses template:
LongText. - Contains the following components: permissions.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/timezones.Documentation: https://developer.mypurecloud.com/api/rest/v2/utilities/index.html#getTimezones.
- id
A key field. Template: Id.
- name
Template: ShortText.
- offset
Data type: DT_I4
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/voicemail/messages.Documentation: https://developer.mypurecloud.com/api/rest/v2/voicemail/index.html#getVoicemailMessages.
- [Read group] action
-
Endpoint URL address:
/voicemail/groups/{{=parameters.groupId}}/messages.The action has the following user-defined parameters:
- groupId: Required. Specify group identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/voicemail/index.html#getVoicemailGroupMessages.
- [Read queue] action
-
Endpoint URL address:
/voicemail/queues/{{=parameters.queueId}}/messages.The action has the following user-defined parameters:
- queueId: Required. Specify queue identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/voicemail/index.html#getVoicemailQueueMessages.
- [Read search] action
-
Endpoint URL address:
/voicemail/search.
The result is extracted from:{{=response.results}}.
The action uses POST method.Documentation: https://developer.mypurecloud.com/api/rest/v2/voicemail/index.html#postVoicemailSearch.
- [Update] action
-
Endpoint URL address:
/voicemail/messages/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/voicemail/index.html#putVoicemailMessage.
- [Delete] action
-
Endpoint URL address:
/voicemail/messages/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/voicemail/index.html#deleteVoicemailMessage.
- id
A key field. Template: Id.
- conversation
Template: Conversation. Field components:
-
Uses template:
LongText. - Contains the following components: conversationIds, maxParticipants, recordingState, state, selfUri.
-
Uses template:
- read
Data type: DT_BOOL
- audioRecordingDurationSeconds
Data type: DT_I4 A read-only field.
- audioRecordingSizeBytes
Data type: DT_I4 A read-only field.
- createdDate
Template: ShortText. A read-only field.
- modifiedDate
Template: ShortText. A read-only field.
- deletedDate
Template: ShortText. A read-only field.
- callerAddress
Template: ShortText.
- callerName
Template: ShortText.
- callerUser
Template: User.
- deleted
Data type: DT_BOOL
- note
Template: ShortText.
- user
Template: User.
- group
Template: Group.
- queue
Template: Queue.
- copiedFrom
Field components:
-
Uses template:
User. - Contains the following components: user, group, date.
-
Uses template:
- copiedTo
An array field. Field components:
-
Uses template:
User. - Contains the following components: user, group, date.
-
Uses template:
- deleteRetentionPolicy
Field components:
-
Uses template:
ShortText. - Contains the following components: voicemailRetentionPolicyType, numberOfDays.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
- media
Data type: DT_IMAGE The value is gathered from
/voicemail/messages/{{=item.id}}/mediaaddress. The gathered value is processed with{{=connection.execute({ url: response.mediaFileUri })}}expression.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/webchat/deployments.Documentation: https://developer.mypurecloud.com/api/rest/v2/webchat/index.html#getWebchatDeployments.
- [Create] action
-
Endpoint URL address:
/webchat/deployments.Documentation: https://developer.mypurecloud.com/api/rest/v2/webchat/index.html#postWebchatDeployments.
- [Update] action
-
Endpoint URL address:
/webchat/deployments/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/webchat/index.html#putWebchatDeployment.
- [Delete] action
-
Endpoint URL address:
/webchat/deployments/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/webchat/index.html#deleteWebchatDeployment.
- id
A key field. Template: Id.
- name
Template: ShortText.
- description
Template: LongText.
- authenticationRequired
Data type: DT_BOOL
- authenticationUrl
Template: ShortText.
- disabled
Data type: DT_BOOL
- webChatConfig
Field components:
-
Uses template:
ShortText. - Contains the following components: webChatSkin.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
- [Read] action
-
Endpoint URL address:
/workforcemanagement/adherence.The action has the following user-defined parameters:
- userIds: Required. Specify comma (,) separated list of user identifiers.
The following request parameters will be automatically processed:
-
userId:
{{=parameters.userIds.split(',')}}
Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#getWorkforcemanagementAdherence.
- id
A key field. Template: Id.
- name
Template: ShortText.
- user
Template: User.
- managementUnit
Template: ManagementUnit.
- scheduledActivityCategory
Template: ShortText.
- systemPresence
Template: ShortText.
- organizationSecondaryPresenceId
Template: Id.
- routingStatus
Template: ShortText.
- actualActivityCategory
Template: ShortText.
- isOutOfOffice
Data type: DT_BOOL
- adherenceState
Template: ShortText.
- impact
Template: ShortText.
- timeOfAdherenceChange
Template: ShortText.
- presenceUpdateTime
Template: ShortText.
- selfUri
Template: ShortText. A read-only field.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/workforcemanagement/managementunits.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#getWorkforcemanagementManagementunits.
- [Create] action
-
Endpoint URL address:
/workforcemanagement/managementunits.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#postWorkforcemanagementManagementunits.
- [Delete] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#deleteWorkforcemanagementManagementunit.
The resource includes the fields from the ManagementUnit template.
- [Read] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=parameters.managementUnitId}}/scheduling/runs.
The result is extracted from:{{=response.entities}}.The action has the following user-defined parameters:
- managementUnitId: Required. Specify management unit identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#getWorkforcemanagementManagementunitSchedulingRuns.
- [Delete] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=item.managementUnitId}}/scheduling/runs/{{=item.runId}}.
The action uses DELETE method.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#deleteWorkforcemanagementManagementunitSchedulingRun.
- runId
A key field. Template: Id.
- schedulerRunId
Template: Id.
- intradayRescheduling
Data type: DT_BOOL
- state
Template: ShortText.
- percentComplete
Template: LongText.
- targetWeek
Template: ShortText.
- scheduleId
Template: Id.
- scheduleDescription
Template: LongText.
- schedulingStartTime
Template: DateTime.
- schedulingStartedBy
Template: UriReference.
- schedulingCanceledBy
Template: UriReference.
- schedulingCompletedTime
Template: DateTime.
- reschedulingOptions
Field components:
-
Uses template:
DateTime. - Contains the following components: startDate, endDate, agentIds, activityCodeIds, doNotChangeWeeklyPaidTime, doNotChangeDailyPaidTime, doNotChangeShiftStartTimes, doNotChangeManuallyEditedShifts, existingScheduleId, existingScheduleVersion.
-
Uses template:
- reschedulingResultExpiration
Template: ShortText.
- applied
Data type: DT_BOOL
- unscheduledAgents
An array field. Field components:
-
Uses template:
UriReference. - Contains the following components: agent, unscheduledReason.
-
Uses template:
- managementUnitId
A key field. Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=parameters.managementUnitId}}/servicegoalgroups.The action has the following user-defined parameters:
- managementUnitId: Required. Specify management unit identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#postWorkforcemanagementManagementunitServicegoalgroups.
- [Create] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=item.managementUnitId}}/servicegoalgroups.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#postWorkforcemanagementManagementunitServicegoalgroups.
- [Update] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=item.managementUnitId}}/servicegoalgroups/{{=item.id}}.
The action uses PATCH method.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#patchWorkforcemanagementManagementunitServicegoalgroup.
- [Delete] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=item.managementUnitId}}/servicegoalgroups/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#deleteWorkforcemanagementManagementunitServicegoalgroup.
- id
A key field. Template: Id.
- name
Template: ShortText.
- goals
Field components:
- Contains the following components: serviceLevel, averageSpeedOfAnswer, abandonRate.
- queueMediaAssociations
An array field. Field components:
-
Uses template:
Id. - Contains the following components: id, queue, mediaTypes, delete.
-
Uses template:
- metadata
Field components:
-
Uses template:
UriReference. - Contains the following components: version, modifiedBy, dateModified.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
- managementUnitId
A key field. Template: Id.
- [Read] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=parameters.managementUnitId}}/weeks/{{=parameters.weekDateId}}/shorttermforecasts.The action has the following user-defined parameters:
- managementUnitId: Required. Specify management unit identifier.
- weekDateId: Required. Specify week date identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#getWorkforcemanagementManagementunitWeekShorttermforecasts.
- [Delete] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=item.managementUnitId}}/weeks/{{=item.weekDateId}}/shorttermforecasts/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#deleteWorkforcemanagementManagementunitWeekShorttermforecast.
- id
A key field. Template: Id.
- weekDate
Template: ShortText.
- description
Template: LongText.
- creationMethod
Template: ShortText.
- metadata
Field components:
-
Uses template:
UriReference. - Contains the following components: version, modifiedBy, dateModified.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
- managementUnitId
Template: Id.
- weekDateId
Template: Id.
- finalResult
The value is gathered from
/workforcemanagement/managementunits/{{=item.managementUnitId}}/weeks/{{=item.weekDateId}}/shorttermforecasts/{{=item.id}}/finaladdress. The gathered value is processed with{{=response.result}}expression. Field components:-
Uses template:
DateTime. - Contains the following components: startDate, routeGroups.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{parameters.managementUnitId}/weeks/{{=parameters.weekId}}/schedules.The action has the following user-defined parameters:
- managementUnitId: Required. Specify management unit identifier.
- weekId: Required. Specify week identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#getWorkforcemanagementManagementunitWeekSchedules.
- [Update] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=item.managementUnitId}/weeks/{{=item.weekId}}/schedules/{{=item.id}}.
The action uses PATCH method.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#patchWorkforcemanagementManagementunitWeekSchedule.
- [Delete] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=item.managementUnitId}/weeks/{{=item.weekId}}/schedules/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#deleteWorkforcemanagementManagementunitWeekSchedule.
- id
A key field. Template: Id.
- weekDate
Template: ShortText.
- description
Template: LongText.
- published
Data type: DT_BOOL
- generationResults
Field components:
-
Uses template:
Id. - Contains the following components: failed, runId, agentWarnings, agentWarningCount.
-
Uses template:
- shortTermForecast
Field components:
-
Uses template:
Id. - Contains the following components: id, weekDate, description, selfUri.
-
Uses template:
- metadata
Field components:
-
Uses template:
UriReference. - Contains the following components: version, modifiedBy, dateModified.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
- managementUnitId
A key field. Template: Id.
- weekId
A key field. Template: Id.
- generationresults
The value is gathered from
/workforcemanagement/managementunits/{{=item.managementUnitId}}/weeks/{{=item.weekId}}/schedules/{{=item.id}}/generationresultsaddress. Field components:-
Uses template:
Id. - Contains the following components: failed, runId, agentWarnings, agentWarningCount.
-
Uses template:
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=parameters.managementUnitId}}/workplans.The action has the following user-defined parameters:
- managementUnitId: Required. Specify management unit identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#getWorkforcemanagementManagementunitWorkplans.
- [Create] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=item.managementUnitId}}/workplans.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#postWorkforcemanagementManagementunitWorkplans.
- [Update] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=item.managementUnitId}}/workplans/{{=item.id}}.
The action uses PATCH method.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#patchWorkforcemanagementManagementunitWorkplan.
- [Delete] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=item.managementUnitId}}/workplans/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#deleteWorkforcemanagementManagementunitWorkplan.
- id
A key field. Template: Id.
- name
Template: ShortText.
- enabled
Data type: DT_BOOL
- constrainWeeklyPaidTime
Data type: DT_BOOL
- flexibleWeeklyPaidTime
Data type: DT_BOOL
- weeklyExactPaidMinutes
Data type: DT_I4
- weeklyMinimumPaidMinutes
Data type: DT_I4
- weeklyMaximumPaidMinutes
Data type: DT_I4
- constrainPaidTimeGranularity
Data type: DT_BOOL
- paidTimeGranularityMinutes
Data type: DT_I4
- constrainMinimumTimeBetweenShifts
Data type: DT_BOOL
- minimumTimeBetweenShiftsMinutes
Data type: DT_I4
- maximumDays
Data type: DT_I4
- optionalDays
Field components:
-
Uses template:
LongText. - Contains the following components: values.
-
Uses template:
- shiftStartVariances
Field components:
- An array.
- Contains the following components: applicableDays, maxShiftStartVarianceMinutes.
- shifts
Template: Shift. An array field.
- agents
An array field. Field components:
-
Uses template:
Id. - Contains the following components: id, delete, selfUri.
-
Uses template:
- metadata
Field components:
-
Uses template:
UriReference. - Contains the following components: version, modifiedBy, dateModified.
-
Uses template:
- agentCount
Data type: DT_I4
- selfUri
Template: ShortText. A read-only field.
- managementUnitId
Template: Id.
Based on resource template Base.
- [Read] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=parameters.managementUnitId}}/activitycodes.The action has the following user-defined parameters:
- managementUnitId: Required. Specify management unit identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#getWorkforcemanagementManagementunitActivitycodes.
- [Create] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=item.managementUnitId}}/activitycodes.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#postWorkforcemanagementManagementunitActivitycodes.
- [Update] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=item.managementUnitId}}/activitycodes/{{=item.id}}.
The action uses PATCH method.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#patchWorkforcemanagementManagementunitActivitycode.
- [Delete] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=item.managementUnitId}}/activitycodes/{{=item.id}}.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#deleteWorkforcemanagementManagementunitActivitycode.
- id
A key field. Template: Id.
- name
Template: ShortText.
- isActive
Data type: DT_BOOL
- isDefault
Data type: DT_BOOL
- category
Template: ShortText.
- lengthMinutes
Data type: DT_I4
- countsAsPaidTime
Data type: DT_BOOL
- countsAsWorkTime
Data type: DT_BOOL
- agentTimeOffSelectable
Data type: DT_BOOL
- metadata
Field components:
-
Uses template:
UriReference. - Contains the following components: version, modifiedBy, dateModified.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
- managementUnitId
A key field. Template: Id.
- [Read] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=parameters.managementUnitId}}/schedules/search.
The result is extracted from:{{=response.userSchedules}}.
The action uses POST method.The action has the following user-defined parameters:
- managementUnitId: Required. Specify management unit identifier.
- userIds: Required. Specify comma (,) separated list of user identifiers.
- startDate: Required. Specify start date.
- endDate: Required. Specify end date.
The following request parameters will be automatically processed:
-
application/json:
{{={ userIds: parameters.userIds.split(','), startDate: parameters.startDate, endDate: parameters.endDate } }}
Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#postWorkforcemanagementManagementunitSchedulesSearch.
- shifts
Template: Shift. An array field.
- fullDayTimeOffMarkers
An array field. Field components:
-
Uses template:
DateTime. - Contains the following components: managementUnitDate, activityCodeId, isPaid, lengthInMinutes, description, delete.
-
Uses template:
- delete
Data type: DT_BOOL
- metadata
Field components:
-
Uses template:
UriReference. - Contains the following components: version, modifiedBy, dateModified.
-
Uses template:
- workPlanId
Template: Id.
Based on resource template Base.
- [Read user] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=parameters.managementUnitId}}/users/{{=parameters.userId}}/timeoffrequests.
The result is extracted from:{{=response.timeOffRequests}}.The action has the following user-defined parameters:
- managementUnitId: Required. Specify management unit identifier.
- userId: Required. Specify user identifier.
Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#getWorkforcemanagementManagementunitUserTimeoffrequests.
- [Create] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=item.managementUnitId}}/timeoffrequests.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#postWorkforcemanagementManagementunitTimeoffrequests.
- [Update] action
-
Endpoint URL address:
/workforcemanagement/managementunits/{{=item.managementUnitId}}/users/{{=item.userId}}/timeoffrequests/{{=item.id}}.
The action uses PATCH method.Documentation: https://developer.mypurecloud.com/api/rest/v2/workforcemanagement/index.html#patchWorkforcemanagementManagementunitUserTimeoffrequest.
- id
A key field. Template: Id.
- user
Template: User.
- isFullDayRequest
Data type: DT_BOOL
- markedAsRead
Data type: DT_BOOL
- activityCodeId
Template: Id.
- status
Template: ShortText.
- partialDayStartDateTimes
Template: LongText.
- fullDayManagementUnitDates
Template: LongText.
- dailyDurationMinutes
Data type: DT_I4
- notes
Template: ShortText.
- submittedBy
Template: User.
- submittedDate
Template: DateTime.
- reviewedBy
Template: User.
- reviewedDate
Template: DateTime.
- modifiedBy
Template: UriReference.
- modifiedDate
Template: DateTime.
- metadata
Field components:
-
Uses template:
UriReference. - Contains the following components: version, modifiedBy, dateModified.
-
Uses template:
- selfUri
Template: ShortText. A read-only field.
- managementUnitId
Template: Id.
- userId
Template: Id.
- [Read] action
-
The result is extracted from:{{=response.entities}}.
The result is paginated.The following request parameters will be automatically processed:
-
pageNumber:
{{=parameters.iterator}} -
pageSize:
{{=parameters.batchSize}} -
_includeUserParameters:
{{=parameters}}
-
pageNumber:
- [Create] action
-
The action uses POST method.The following request parameters will be automatically processed:
-
application/json:
{{=item}} -
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Update] action
-
The action uses PUT method.The following request parameters will be automatically processed:
-
application/json:
{{=item}} -
_includeUserParameters:
{{=parameters}}
-
application/json:
- [Delete] action
-
The action uses DELETE method.
- [Read] action
-
The result is extracted from:{{=response.results}}.
The action uses POST method.The action has the following user-defined parameters:
- query: Specify query JSON statement.
The following request parameters will be automatically processed:
-
application/json:
{{=JSON.parse(parameters.query)}}
- group
Field components:
-
Uses template:
ShortText. - Contains the following components: mediaType, queueId, userId.
-
Uses template:
- data
An array field. Field components:
-
Uses template:
ShortText. - Contains the following components: interval, metrics.
-
Uses template:
- Id
Data type: DT_WSTR ( length 36 )
- ShortText
Data type: DT_WSTR ( length 255 )
- LongText
Data type: DT_WSTR ( length 1000 )
- DateTime
Data type: DT_DBTIMESTAMP
- UriReference
Field components:
-
Uses template:
Id. - Contains the following components: id, name, selfUri.
-
Uses template:
- IpAddress
Field components:
-
Uses template:
ShortText. - Contains the following components: address, display, mediaType, type, extension.
-
Uses template:
- Chat
Field components:
-
Uses template:
ShortText. - Contains the following components: jabberId.
-
Uses template:
- Image
Field components:
-
Uses template:
ShortText. - Contains the following components: resolution, imageUri, height, width.
-
Uses template:
- Group
Field components:
-
Uses template:
Id. - Contains the following components: id, name, description, dateModified, memberCount, state, version, type, images, addresses, rulesVisible, visibility, owners, selfUri.
-
Uses template:
- Organization
Field components:
-
Uses template:
Id. - Contains the following components: id, name, defaultLanguage, defaultCountryCode, thirdPartyOrgName, thirdPartyURI, domain, version, state, defaultSiteId, supportURI, voicemailEnabled, selfUri, features.
-
Uses template:
- RoutingStatus
Field components:
-
Uses template:
Id. - Contains the following components: userId, status, startTime.
-
Uses template:
- Skill
Field components:
-
Uses template:
Id. - Contains the following components: id, name, proficiency, state, skillUri, selfUri.
-
Uses template:
- Language
Field components:
-
Uses template:
Id. - Contains the following components: id, name, proficiency, state, languageUri, selfUri.
-
Uses template:
- Presence
Field components:
-
Uses template:
Id. - Contains the following components: id, name, source, primary, presenceDefinition, message, modifiedDate, selfUri.
-
Uses template:
- SummaryComponent
Field components:
-
Uses template:
LongText. - Contains the following components: contactCenter, enterprise.
-
Uses template:
- ConversationSummary
Field components:
-
Uses template:
Id. - Contains the following components: userId, call, callback, email, message, chat, socialExpression, video.
-
Uses template:
- OutOfOffice
Field components:
-
Uses template:
Id. - Contains the following components: id, name, user, startDate, endDate, active, indefinite, selfUri.
-
Uses template:
- Location
Field components:
-
Uses template:
Id. - Contains the following components: id, name, address, addressVerified, emergencyNumber, state, version, path, selfUri.
-
Uses template:
- Geolocation
Field components:
-
Uses template:
Id. - Contains the following components: id, name, type, primary, latitude, longitude, country, region, city, locations, selfUri.
-
Uses template:
- Station
Field components:
-
Uses template:
Id. - Contains the following components: id, name, type, associatedUser, associatedDate, defaultUser, providerInfo.
-
Uses template:
- Authorization
Field components:
-
Uses template:
LongText. - Contains the following components: roles, permissions, permissionPolicies.
-
Uses template:
- User
Field components:
-
Uses template:
Id. - Contains the following components: id, name, division, chat, department, email, primaryContactInfo, addresses, state, title, username, images, version, routingStatus, presence, conversationSummary, outOfOffice, geolocation, station, authorization, profileSkills, locations, groups, skills, languages, acdAutoAnswer, languagePreference, organization, selfUri.
-
Uses template:
- JobHistory
Field components:
-
Uses template:
Id. - Contains the following components: id, name, reportId, runTime, runStatus, errorMessage, runDurationMsec, reportUrl, reportFormat, scheduleUri, selfUri.
-
Uses template:
- Criteria
Field components:
-
Uses template:
ShortText. - Contains the following components: gt, gte, lt, lte.
-
Uses template:
- DependencyObject
Field components:
-
Uses template:
Id. - Contains the following components: id, name, version, type, deleted, updated, stateUnknown, selfUri.
-
Uses template:
- PromptAsset
Field components:
-
Uses template:
Id. - Contains the following components: id, name, promptId, language, mediaUri, ttsString, text, uploadStatus, uploadUri, languageDefault, tags, durationSeconds, selfUri.
-
Uses template:
- FlowVersion
Field components:
-
Uses template:
Id. - Contains the following components: Id, name, commitVersion, configurationVersion, type, secure, createdBy, configurationUri, dateCreated, generationId, publishResultUri, selfUri.
-
Uses template:
- Operation
Field components:
-
Uses template:
Id. - Contains the following components: id, complete, user, errorMessage, errorCode, errorDetails, errorMessageParams, actionName, actionStatus.
-
Uses template:
- AttributeT
Field components:
-
Uses template:
Id. - Contains the following components: id, name, version, description, createdBy, dateCreated, modifiedBy, dateModified, selfUri.
-
Uses template:
- TagValue
Field components:
-
Uses template:
Id. - Contains the following components: id, name, inUse, acl, selfUri.
-
Uses template:
- PhoneNumber
Template: ShortText. Field components:
-
Uses template:
ShortText. - Contains the following components: display, extension, acceptsSMS, userInput, e164, countryCode.
-
Uses template:
- TwitterId
Field components:
-
Uses template:
ShortText. - Contains the following components: id, name, screenName, verified, profileUrl.
-
Uses template:
- MailAddress
Field components:
-
Uses template:
ShortText. - Contains the following components: address1, address2, city, state, postalCode, countryCode.
-
Uses template:
- ExternalDataSource
Field components:
-
Uses template:
ShortText. - Contains the following components: platform, url.
-
Uses template:
- ExternalOrganization
Field components:
-
Uses template:
Id. - Contains the following components: id, name, companyType, industry, primaryContactId, address, phoneNumber, faxNumber, employeeCount, revenue, tags, websites, tickers, twitterId, externalSystemUrl, modifyDate, createDate, trustor, externalDataSources, selfUri.
-
Uses template:
- ExternalContact
Field components:
-
Uses template:
Id. - Contains the following components: id, firstName, middleName, lastName, salutation, title, workPhone, cellPhone, homePhone, otherPhone, workEmail, personalEmail, otherEmail, address, twitterId, lineId, facebookId, modifyDate, createDate, externalOrganization, surveyOptOut, externalSystemUrl, externalDataSources, selfUri.
-
Uses template:
- Note
Field components:
-
Uses template:
Id. - Contains the following components: id, name, noteText, modifyDate, createDate, createdBy, externalDataSources, selfUri.
-
Uses template:
- Greeting
Field components:
-
Uses template:
Id. - Contains the following components: id, name, selfUri, type, ownerType, owner, audioFile, audioTTS, createdDate, createdBy, modifiedDate, modifiedBy.
-
Uses template:
- Action
Field components:
-
Uses template:
Id. - Contains the following components: id, name, integrationId, category, category, contract, version, secure, config, selfUri.
-
Uses template:
- RuleParameter
Field components:
-
Uses template:
ShortText. - Contains the following components: operator, value, priority, dialingMode.
-
Uses template:
- CampaignRuleEntity
Field components:
-
Uses template:
UriReference. - Contains the following components: campaigns, sequences.
-
Uses template:
- ContactSort
Field components:
-
Uses template:
ShortText. - Contains the following components: fieldName, direction, numeric.
-
Uses template:
- Conversation
Field components:
-
Uses template:
Id. - Contains the following components: id, name, startTime, endTime, selfUri, participants.
-
Uses template:
- Interaction
Field components:
-
Uses template:
Id. - Contains the following components: Id, campaign, agent, contact, destinationAddress, activePreviewCall, lastActivePreviewWrapupTime, creationTime, callPlacedTime, callRoutedTime, previewConnectedTime, queue, script, disposition, callerName, callerAddress, previewPopDeliveredTime, conversation.
-
Uses template:
- ImportStatus
Field components:
-
Uses template:
ShortText. - Contains the following components: state, totalRecords, completedRecords, percentComplete, failureReason.
-
Uses template:
- Message
Field components:
-
Uses template:
ShortText. - Contains the following components: localizableMessageCode, message, messageWithParams, messageParams.
-
Uses template:
- Schedule
Field components:
-
Uses template:
Id. - Contains the following components: id, name, dateCreated, dateModified, version, intervals, timeZone, selfUri.
-
Uses template:
- VisibilityCondition
Field components:
-
Uses template:
ShortText. - Contains the following components: combiningOperation, predicates.
-
Uses template:
- PublishedVersion
Field components:
-
Uses template:
ShortText. - Contains the following components: entities, pageSize, pageNumber, total, firstUri, selfUri, previousUri, nextUri, lastUri, pageCount.
-
Uses template:
- EvaluationForm
Field components:
-
Uses template:
Id. - Contains the following components: id, name, modifiedDate, published, contextId, questionGroups, publishedVersions, selfUri.
-
Uses template:
- Queue
Field components:
-
Uses template:
Id. - Contains the following components: id, name, division, description, version, dateCreated, dateModified, modifiedBy, createdBy, state, modifiedByApp, createdByApp, mediaSettings, bullseye, acwSettings, skillEvaluationMethod, queueFlow, whisperPrompt, autoAnswerOnly, callingPartyName, callingPartyNumber, defaultScripts, outboundMessagingAddresses, outboundEmailAddress, memberCount, selfUri.
-
Uses template:
- Calibration
Field components:
-
Uses template:
Id. - Contains the following components: id, name, calibrator, agent, conversation, evaluationForm, contextId, averageScore, highScore, lowScore, createdDate, evaluations, evaluators, scoringIndex, expertEvaluator, selfUri.
-
Uses template:
- Evaluation
Field components:
-
Uses template:
Id. - Contains the following components: id, name, conversation, evaluationForm, evaluator, agent, calibration, status, answers, agentHasRead, releaseDate, assignedDate, changedDate, queue, neverRelease, resourceId, resourceType, redacted, isScoringIndex, selfUri.
-
Uses template:
- Change
Field components:
-
Uses template:
ShortText. - Contains the following components: entity, property, oldValues, newValues.
-
Uses template:
Field components:
-
Uses template:
ShortText. - Contains the following components: email, name.
-
Uses template:
- Annotation
Field components:
-
Uses template:
Id. - Contains the following components: id, name, type, location, durationMs, absoluteLocation, absoluteDurationMs, recordingLocation, recordingDurationMs, user, description, keywordName, confidence, keywordSetId, keywordSetName, utterance, timeBegin, timeEnd, keywordConfidenceThreshold, agentScoreModifier, customerScoreModifier, selfUri.
-
Uses template:
- Recording
Field components:
-
Uses template:
Id. - Contains the following components: id, name, conversationId, path, startTime, endTime, media, annotations, transcript, emailTranscript, messagingTranscript, fileState, restoreExpirationTime, mediaUris, estimatedTranscodeTimeMs, actualTranscodeTimeMs, archiveDate, archiveMedium, deleteDate, maxAllowedRestorationsForOrg, remainingRestorationsAllowedForOrg, sessionId, users, selfUri.
-
Uses template:
- MediaPolicy
Field components:
-
Uses template:
LongText. - Contains the following components: actions, conditions.
-
Uses template:
- WrapupCode
Field components:
-
Uses template:
Id. - Contains the following components: id, name, dateCreated, dateModified, modifiedBy, createdBy, selfUri.
-
Uses template:
- Flow
Field components:
-
Uses template:
Id. - Contains the following components: id, name, division, description, type, lockedUser, active, system, deleted, publishedVersion, savedVersion, inputSchema, outputSchema, checkedInVersion, publishedBy, currentOperation, selfUri.
-
Uses template:
- TrunkBase
Field components:
-
Uses template:
Id. - Contains the following components: id, name, description, version, dateCreated, dateModified, modifiedBy, createdBy, state, modifiedByApp, createdByApp, trunkMetabase, properties, trunkType, managed, selfUri.
-
Uses template:
- EdgeGroup
Field components:
-
Uses template:
Id. - Contains the following components: id, name, description, version, dateCreated, dateModified, modifiedBy, createdBy, state, modifiedByApp, createdByApp, managed, edgeTrunkBaseAssignment, phoneTrunkBases, selfUri.
-
Uses template:
- SoftwareStatus
Field components:
-
Uses template:
DateTime. - Contains the following components: version, maxDownloadRate, downloadStartTime, executeStartTime, executeStopTime, executeOnIdle, status, edgeUri, callDrainingWaitTimeSeconds, current.
-
Uses template:
- Edge
Field components:
-
Uses template:
Id. - Contains the following components: id, name, description, version, dateCreated, dateModified, modifiedBy, createdBy, state, modifiedByApp, createdByApp, interfaces, make, model, apiVersion, softwareVersion, softwareVersionTimestamp, softwareVersionPlatform, softwareVersionConfiguration, fullSoftwareVersion, pairingId, fingerprint, fingerprintHint, currentVersion, stagedVersion, patch, statusCode, edgeGroup, site, softwareStatus, onlineStatus, serialNumber, physicalEdge, managed, edgeDeploymentType, callDrainingState, conversationCount, proxy, offlineConfigCalled, osName, selfUri.
-
Uses template:
- EndPoint
Field components:
-
Uses template:
Id. - Contains the following components: id, name, description, version, dateCreated, dateModified, modifiedBy, createdBy, state, modifiedByApp, createdByApp, count, properties, schema, enabled, site, dids, selfUri.
-
Uses template:
- Site
Field components:
-
Uses template:
id. - Contains the following components: id, name, description, version, dateCreated, dateModified, modifiedBy, createdBy, state, modifiedByApp, createdByApp, primarySites, secondarySites, primaryEdges, secondaryEdges, addresses, edges, edgeAutoUpdateConfig, location, managed, ntpSettings, selfUri.
-
Uses template:
- LineBaseSetting
Field components:
-
Uses template:
Id. - Contains the following components: id, name, description, version, dateCreated, dateModified, modifiedBy, createdBy, state, modifiedByApp, createdByApp, lineMetaBase, properties, selfUri.
-
Uses template:
- Status
Field components:
-
Uses template:
Id. - Contains the following components: id, name, operationalStatus, edgesStatus, eventCreationTime, provision, lineStatuses, phoneAssignmentToEdgeType, edge, selfUri.
-
Uses template:
- Line
Field components:
-
Uses template:
Id. - Contains the following components: id, name, description, version, dateCreated, dateModified, modifiedBy, createdBy, state, modifiedByApp, createdByApp, properties, edgeGroup, template, site, lineBaseSettings, primaryEdge, secondaryEdge, loggedInUser, defaultForUser, selfUri.
-
Uses template:
- Capabilities
Field components:
-
Uses template:
ShortText. - Contains the following components: provisions, registers, dualRegisters, hardwareIdType, allowReboot, noRebalance, noCloudProvisioning.
-
Uses template:
- MetaBase
Field components:
-
Uses template:
Id. - Contains the following components: id, name, description, version, dateCreated, dateModified, modifiedBy, createdBy, state, modifiedByApp, createdByApp, type, selfUri.
-
Uses template:
- UserProfile
Field components:
-
Uses template:
Id. - Contains the following components: id, name, state, dateModified, version, expands, selfUri.
-
Uses template:
- ManagementUnit
Field components:
-
Uses template:
Id. - Contains the following components: id, name, division, startDayOfWeek, timeZone, settings, version, dateModified, modifiedBy, metadata, selfUri.
-
Uses template:
- Shift
Field components:
-
Uses template:
Id. - Contains the following components: id, name, days, flexibleStartTime, exactStartTimeMinutesFromMidnight, earliestStartTimeMinutesFromMidnight, latestStartTimeMinutesFromMidnight, constrainStopTime, latestStopTimeMinutesFromMidnight, startIncrementMinutes, flexiblePaidTime, exactPaidTimeMinutes, minimumPaidTimeMinutes, maximumPaidTimeMinutes, constrainContiguousWorkTime, minimumContiguousWorkTimeMinutes, maximumContiguousWorkTimeMinutes, activities, delete.
-
Uses template:
What's New
- New: Support for OAuth authentication.
- Fixed: Failed to retrieve all data from 'User Status Detail Query' resource (Thank you, Henrik).
- Fixed: Included definition for missing fields in 'Conversation Detail Query' resource.
- Fixed: Failed to retrieve data from 'Billable Usage' resource (Thank you, Anna).
- New: Introduced connection.
COZYROC SSIS+ Components Suite is free for testing in your development environment.
A licensed version can be deployed on-premises, on Azure-SSIS IR and on COZYROC Cloud.