Examples of Input/Output for Customization Services
Here you can find examples for the input and output for customization services, listed in alphabetical order according to service name.
CalculateProgress
Parameters:
input:
{
"version": "1.0.0",
"data": [
{
"adapter": {
"thingName": "PTC.WCAdapter",
"instanceName": "windchill"
},
"itemListsData": [
{
"objectType": "PTC.Workflow.WorkItem",
"items": [
{
"id": {
"value": "OR:wt.workflow.work.WorkItem:326525"
}
}
]
}
]
}
]
}
configuration:
{
"progressBarMessage": {
"version": "1.0.0",
"value": "[[PTC.Nav.TaskProgress.ProgressBarMessage]]"
},
"title": {
"version": "1.0.0",
"value": "[[PTC.Nav.TaskProgress.Title]]"
},
"baseConfigurationVersion": {
"value": "9.0.0"
},
"implementationConfigurationVersion": {
"value": "9.0.0"
}
}
Returns:
{
"data": {
"timeStamp": "2020-05-28 17:57:08.056",
"data": [
{
"itemListsData": [
{
"metadata": {
"Reject": {
"icon": "/Thingworx/MediaEntities/PTC.Nav.TaskProgress.RejectedIcon",
"step": "1",
"label": "Reject",
"ordinal": "1"
},
"PendingTasks": {
"icon": "/Thingworx/MediaEntities/PTC.Nav.TaskProgress.PendingIcon",
"step": "0",
"label": "[[PTC.Nav.TaskProgress.PendingTasks]]",
"ordinal": "3"
},
"Approve": {
"icon": "/Thingworx/MediaEntities/PTC.Nav.TaskProgress.ApprovedIcon",
"step": "1",
"label": "Approve",
"ordinal": "0"
},
"Analyze": {
"icon": "/Thingworx/MediaEntities/PTC.Nav.TaskProgress.ClarifyIcon",
"step": "1",
"label": "Analyze",
"ordinal": "2"
}
},
"items": [
{
"Reject": {
"value": "1"
},
"PendingTasks": {
"value": "1"
},
"Approve": {
"value": "4"
},
"Analyze": {
"value": "1"
}
}
]
}
]
}
],
"version": "1.0.0",
"statusMessage": "OK",
"status": "200"
},
"stepsMetadata": {}
}
GetAdditionalAttributes
Returns:
{
"timeStamp": "2020-05-28 16:32:26.605",
"data": [
{
"itemListsData": [
{
"metadata": {
"Additional_Attr1": {
"label": "Additional attribute 1",
"type": "String"
},
"Additional_Attr2": {
"label": "Additional attribute 2",
"type": "String"
}
},
"items": [
{
"Additional_Attr1": {
"value": ""
},
"Additional_Attr2": {
"value": ""
}
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest.Custom.Implementation"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"version": "1.0.0",
"statusMessage": "OK",
"status": "200"
}
GetAdditionalAttributesValues
Parameters:
Sample for configuration is from Tiles.
input:
{
"version": "1.0.0",
"data": [
{
"adapter": {
"thingName": "PTC.WCAdapter",
"instanceName": "windchill"
},
"itemListsData": [
{
"objectType": "PTC.ChangeMgmt.ChangeRequest",
"items": [
{
"id": {
"value": "OR:wt.change2.WTChangeRequest2:911758"
}
}
]
}
]
}
]
}
attributes:
{
"timeStamp": "2020-01-30 12:54:30.014",
"data": [
{
"itemListsData": [
{
"items": [
{
"Additional_Attr1": {
"value": ""
},
"Additional_Attr2": {
"value": ""
}
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest.Custom.Implementation"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
configuration:
{
"baseConfigurationVersion": {
"value": "9.0.0"
},
"implementationConfigurationVersion": {
"value": "9.0.0"
},
"attributes": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"id": "Name",
"ordinal": 0
},
{
"id": "Number",
"ordinal": 1
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest"
},
{
"items": [
{
"id": "Additional_Attr1",
"ordinal": 2
},
{
"id": "Additional_Attr2",
"ordinal": 3
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest.Custom.Implementation"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
},
"maxTileCount": {
"value": "10"
}
}
OOTBAttributesValues:
{
"timeStamp": "2020-05-28 16:30:58.238",
"data": [
{
"itemListsData": [
{
"metadata": {
"Number": {
"label": "Number",
"type": "STRING"
},
"Name": {
"label": "Name",
"type": "STRING"
}
},
"items": [
{
"Number": {
"value": "00280"
},
"Name": {
"value": "GC000002_CR1"
}
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"statusMessage": "OK",
"status": "200"
}
Returns:
{
"timeStamp": "2020-05-28 16:30:58.238",
"data": [
{
"itemListsData": [
{
"metadata": {
"Additional_Attr1": {
"label": "Additional attribute 1",
"type": "STRING"
},
"Additional_Attr2": {
"label": "Additional attribute 2",
"type": "STRING"
}
},
"items": [
{
"Additional_Attr1": {
"value": "Value of additional attribute 1"
},
"Additional_Attr1": {
"value": "Value of additional attribute 2"
}
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest.Custom.Implementation"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"statusMessage": "OK",
"status": "200"
}
GetAdditionalFilterAttributes
Returns:
{
"timeStamp": "2020-05-31 10:12:43.279",
"statusMessage": "OK",
"status": "200"
}
GetAttributesValues
Parameters:
Sample for configuration is from Tiles.
input:
{
"version": "1.0.0",
"data": [
{
"adapter": {
"thingName": "PTC.WCAdapter",
"instanceName": "windchill"
},
"itemListsData": [
{
"objectType": "PTC.ChangeMgmt.ChangeRequest",
"items": [
{
"id": {
"value": "OR:wt.change2.WTChangeRequest2:911758"
}
}
]
}
]
}
]
}
attributes:
{
"timeStamp": "2020-01-30 12:54:30.014",
"data": [
{
"itemListsData": [
{
"items": [
{
"Name": {
"value": ""
},
"Number": {
"value": ""
}
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
Returns:
{
"timeStamp": "2020-05-28 16:30:58.238",
"data": [
{
"itemListsData": [
{
"metadata": {
"Number": {
"label": "Number",
"type": "STRING"
},
"ID": {
"label": "ID",
"type": "STRING"
},
"Name": {
"label": "Name",
"type": "STRING"
}
},
"items": [
{
"Number": {
"value": "00280"
},
"ID": {
"value": "OR:wt.change2.WTChangeRequest2:911758"
},
"Name": {
"value": "GC000002_CR1"
}
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"statusMessage": "OK",
"status": "200"
}
GetConfigurations
Returns:
Sample is from Tasks.
{
"taskList": {
"configuration": {
"actionBarConfiguration": {
"value": {
"actionBarConfigurationJSON": {
"value": "{\"maxItemsToShow\": {\"value\": 2},\"modelThingName\": {\"entityName\": \"PTC.ActionBarModel.Thing\"},\"actions\": {\"selectedValues\": {\"data\": [{\"itemListsData\": [{\"items\": [{\"id\": \"Reassign\",\"additionalData\": {\"actionConfiguration\": {\"iconWhenDisabled\": {\"entityName\": \"PTC.ActionBar.ReassignDisabledIcon\"},\"iconWhenHovered\": {\"entityName\": \"PTC.ActionBar.ReassignHoverIcon\"},\"overrideLabel\": {\"value\": \"[[PTC.Nav.TaskList.TaskReassignLabel]]\"},\"popupHeight\": {\"value\": 579},\"inputConstraints\": {\"selectedKey\": \"InputRequired\"},\"actionButtonVisibility\": {\"selectedKey\": \"AlwaysShown\"},\"buttonStyle\": {\"selectedKey\": \"transparent\"},\"mashupName\": {\"mashupName\": \"PTC.AccessApp.WindchillServices.ReassignActionMashup\"},\"fireEventOnFinish\": {\"value\": false},\"activityType\": {\"selectedKey\": \"popup\"},\"iconWhenEnabled\": {\"entityName\": \"PTC.ActionBar.ReassignIcon\"},\"popupWidth\": {\"value\": 600}}},\"ordinal\": 0}],\"objectType\": \"WT.WorkItem.Actions\"}],\"adapter\": {\"instanceName\": \"windchill\",\"thingName\": \"PTC.WCAdapter\"}}]}}}"
}
}
},
"implementationConfiguration": {
"value": {
"taskTypeFilter": {
"value": "[{\"activityName\": \"Conduct Online CRB Review\",\"workItemProcessTemplate\": \"Change Request Workflow\"}]"
}
}
},
"defaultSortFields": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"additionalData": {
"itemListDefaultSortFieldDefinition": {
"defaultSortDirection": {
"selectedKey": "asc"
}
}
},
"id": "Activity|Deadline"
}
],
"objectType": "PTC.Workflow.WorkItem"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
},
"filterFields": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"additionalData": {
"itemListFilterFieldDefinition": {
"filterLabelOverride": {
"value": "[[PTC.Nav.TaskList.Status]]"
},
"defaultSelectedFilterValues": {
"filters": {
"filters": [
{
"fieldName": "",
"type": "EQ",
"value": "POTENTIAL"
},
{
"fieldName": "",
"type": "EQ",
"value": "ACCEPTED"
}
],
"type": "Or"
}
}
}
},
"id": "Status#Display",
"ordinal": 0
}
],
"objectType": "PTC.Workflow.WorkItem"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
},
"label": {
"value": "[[PTC.Nav.TaskList.Label]]"
},
"showExportAction": {
"inTailoring": true,
"value": true
},
"selectionType": {
"selectedKey": "multi"
},
"waitForInput": {
"value": false
},
"baseConfigurationVersion": {
"value": "9.0.0"
},
"implementationConfigurationVersion": {
"value": "9.0.0"
},
"attributes": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
},
"implementationAttributesDefinition": {
"linkToMashup": {
"mashupName": "PTC.CRDetailedReviewAppMashup"
}
}
},
"id": "Activity|Name",
"ordinal": 0
},
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
}
},
"id": "Subject|SubjectName",
"ordinal": 1
},
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
}
},
"id": "Activity|Deadline",
"ordinal": 2
},
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
}
},
"id": "Status#Display",
"ordinal": 3
},
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
}
},
"id": "Activity|Context|Name",
"ordinal": 4
}
],
"objectType": "PTC.Workflow.WorkItem"
},
{
"items": [
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": "PTC.Nav.TaskList.TaskProgress"
}
}
},
"id": "TaskProgress",
"ordinal": 5
}
],
"objectType": "PTC.Workflow.WorkItem.Custom.Implementation"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
},
"inTailoring": true
},
"enableSearch": {
"additionalData": {
"itemListSearchDefinition": {
"searchHintText": {
"value": "[[PTC.Nav.TaskList.FindHintText]]"
}
}
},
"value": true
},
"maxNumberOfRowsInGrid": {
"inTailoring": true,
"value": 50
}
},
"label": "[[PTC.Nav.TaskList.ConfigLabel]]"
}
}
GetDefaultSelectedFilters
Parameters:
configuration:
{
"actionBarConfiguration": {
"value": {
"actionBarConfigurationJSON": {
"value": "{\"maxItemsToShow\": {\"value\": 2},\"modelThingName\": {\"entityName\": \"PTC.ActionBarModel.Thing\"},\"actions\": {\"selectedValues\": {\"data\": [{\"itemListsData\": [{\"items\": [{\"id\": \"Reassign\",\"additionalData\": {\"actionConfiguration\": {\"iconWhenDisabled\": {\"entityName\": \"PTC.ActionBar.ReassignDisabledIcon\"},\"iconWhenHovered\": {\"entityName\": \"PTC.ActionBar.ReassignHoverIcon\"},\"overrideLabel\": {\"value\": \"[[PTC.Nav.TaskList.TaskReassignLabel]]\"},\"popupHeight\": {\"value\": 579},\"inputConstraints\": {\"selectedKey\": \"InputRequired\"},\"actionButtonVisibility\": {\"selectedKey\": \"AlwaysShown\"},\"buttonStyle\": {\"selectedKey\": \"transparent\"},\"mashupName\": {\"mashupName\": \"PTC.AccessApp.WindchillServices.ReassignActionMashup\"},\"fireEventOnFinish\": {\"value\": false},\"activityType\": {\"selectedKey\": \"popup\"},\"iconWhenEnabled\": {\"entityName\": \"PTC.ActionBar.ReassignIcon\"},\"popupWidth\": {\"value\": 600}}},\"ordinal\": 0}],\"objectType\": \"WT.WorkItem.Actions\"}],\"adapter\": {\"instanceName\": \"windchill\",\"thingName\": \"PTC.WCAdapter\"}}]}}}"
}
}
},
"implementationConfiguration": {
"value": {
"taskTypeFilter": {
"value": "[{\"activityName\": \"Conduct Online CRB Review\",\"workItemProcessTemplate\": \"Change Request Workflow\"}]"
}
}
},
"defaultSortFields": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"additionalData": {
"itemListDefaultSortFieldDefinition": {
"defaultSortDirection": {
"selectedKey": "asc"
}
}
},
"id": "Activity|Deadline"
}
],
"objectType": "PTC.Workflow.WorkItem"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
},
"filterFields": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"additionalData": {
"itemListFilterFieldDefinition": {
"filterLabelOverride": {
"value": "[[PTC.Nav.TaskList.Status]]"
},
"defaultSelectedFilterValues": {
"filters": {
"filters": [
{
"fieldName": "",
"type": "EQ",
"value": "POTENTIAL"
},
{
"fieldName": "",
"type": "EQ",
"value": "ACCEPTED"
}
],
"type": "Or"
}
}
}
},
"id": "Status#Display",
"ordinal": 0
}
],
"objectType": "PTC.Workflow.WorkItem"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
},
"label": {
"value": "[[PTC.Nav.TaskList.Label]]"
},
"showExportAction": {
"value": true
},
"selectionType": {
"selectedKey": "multi"
},
"waitForInput": {
"value": false
},
"baseConfigurationVersion": {
"value": "9.0.0"
},
"implementationConfigurationVersion": {
"value": "9.0.0"
},
"attributes": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
},
"implementationAttributesDefinition": {
"linkToMashup": {
"mashupName": "PTC.CRDetailedReviewAppMashup"
}
}
},
"id": "Activity|Name",
"ordinal": 0
},
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
}
},
"id": "Subject|SubjectName",
"ordinal": 1
},
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
}
},
"id": "Activity|Deadline",
"ordinal": 2
},
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
}
},
"id": "Status#Display",
"ordinal": 3
},
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
}
},
"id": "Activity|Context|Name",
"ordinal": 4
}
],
"objectType": "PTC.Workflow.WorkItem"
},
{
"items": [
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": "PTC.Nav.TaskList.TaskProgress"
}
}
},
"id": "TaskProgress",
"ordinal": 5
}
],
"objectType": "PTC.Workflow.WorkItem.Custom.Implementation"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
},
"enableSearch": {
"additionalData": {
"itemListSearchDefinition": {
"searchHintText": {
"value": "[[PTC.Nav.TaskList.FindHintText]]"
}
}
},
"value": true
},
"maxNumberOfRowsInGrid": {
"value": 500
}
}
Returns:
{
"dataShape": {
"fieldDefinitions": {
"Display": {
"name": "Display",
"description": "enum display",
"baseType": "STRING",
"ordinal": 2,
"aspects": {
"isPrimaryKey": false
}
},
"Value": {
"name": "Value",
"description": "enum value",
"baseType": "STRING",
"ordinal": 1,
"aspects": {
"isPrimaryKey": false
}
}
}
},
"rows": [
{
"Value": "POTENTIAL"
},
{
"Value": "ACCEPTED"
}
]
}
GetItemIdentityAttributes
Parameters:
input:
{
"data": [
{
"itemListsData": [
{
"items": [
{
"id": {
"value": "OR:wt.workflow.work.WorkItem:326525"
}
}
],
"objectType": "PTC.Workflow.WorkItem"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"version": "1.0.0"
}
attributes:
{
"timeStamp": "2020-05-29 11:45:12.604",
"data": [
{
"itemListsData": [
{
"items": [
{
"Category#Display": {
"value": ""
},
"RequestPriority#Display": {
"value": ""
}
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest"
},
{
"items": [
{
"Role#Display": {
"value": ""
},
"Activity|Deadline": {
"value": ""
},
"Status#Display": {
"value": ""
},
"Activity|Name": {
"value": ""
},
"Subject|SubjectName": {
"value": ""
}
}
],
"objectType": "PTC.Workflow.WorkItem"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"statusMessage": "OK",
"status": "200"
}
configuration :
{
"primaryTitle": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"numericIdentifier": 1,
"id": "Subject|SubjectName",
"ordinal": 0
}
],
"objectType": "PTC.Workflow.WorkItem"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
},
"pattern": "%1"
},
"actionBarConfiguration": {
"value": {
"actionBarConfigurationJSON": {
"value": "{ \"maxItemsToShow\": { \"value\": 2 }, \"modelThingName\": { \"entityName\": \"PTC.ActionBarModel.Thing\" }, \"actions\": { \"selectedValues\": { \"data\": [ { \"itemListsData\": [ { \"items\": [ { \"id\": \"Approve\", \"additionalData\": { \"actionConfiguration\": { \"overrideLabel\": { \"value\": \"\" }, \"popupHeight\": { \"value\": 479 }, \"actionButtonVisibility\": { \"selectedKey\": \"HideUnavailable\" }, \"buttonStyle\": { \"selectedKey\": \"primary\" }, \"mashupName\": { \"mashupName\": \"PTC.AccessApp.WindchillServices.RoutingOptionMashup\" }, \"fireEventOnFinish\": { \"value\": false }, \"activityType\": { \"selectedKey\": \"popup\" }, \"redirectAfterPopupSuccess\": { \"mashupName\": \"PTC.MyTasksAppMashup\" }, \"popupWidth\": { \"value\": 600 } } }, \"ordinal\": 10 }, { \"id\": \"Reject\", \"additionalData\": { \"actionConfiguration\": { \"overrideLabel\": { \"value\": \"\" }, \"popupHeight\": { \"value\": 479 }, \"actionButtonVisibility\": { \"selectedKey\": \"HideUnavailable\" }, \"buttonStyle\": { \"selectedKey\": \"primary\" }, \"mashupName\": { \"mashupName\": \"PTC.AccessApp.WindchillServices.RoutingOptionMashup\" }, \"fireEventOnFinish\": { \"value\": false }, \"activityType\": { \"selectedKey\": \"popup\" }, \"redirectAfterPopupSuccess\": { \"mashupName\": \"PTC.MyTasksAppMashup\" }, \"popupWidth\": { \"value\": 600 } } }, \"ordinal\": 20 }, { \"id\": \"Analyze\", \"additionalData\": { \"actionConfiguration\": { \"overrideLabel\": { \"value\": \"\" }, \"popupHeight\": { \"value\": 479 }, \"actionButtonVisibility\": { \"selectedKey\": \"HideUnavailable\" }, \"buttonStyle\": { \"selectedKey\": \"primary\" }, \"mashupName\": { \"mashupName\": \"PTC.AccessApp.WindchillServices.RoutingOptionMashup\" }, \"fireEventOnFinish\": { \"value\": false }, \"activityType\": { \"selectedKey\": \"popup\" }, \"redirectAfterPopupSuccess\": { \"mashupName\": \"PTC.MyTasksAppMashup\" }, \"popupWidth\": { \"value\": 600 } } }, \"ordinal\": 30 }, { \"id\": \"Reassign\", \"additionalData\": { \"actionConfiguration\": { \"overrideLabel\": { \"value\": \"[[PTC.AccessApp.Reassign]]\" }, \"popupHeight\": { \"value\": 579 }, \"actionButtonVisibility\": { \"selectedKey\": \"AlwaysShown\" }, \"buttonStyle\": { \"selectedKey\": \"primary\" }, \"mashupName\": { \"mashupName\": \"PTC.AccessApp.WindchillServices.ReassignActionMashup\" }, \"fireEventOnFinish\": { \"value\": false }, \"activityType\": { \"selectedKey\": \"popup\" }, \"redirectAfterPopupSuccess\": { \"mashupName\": \"PTC.MyTasksAppMashup\" }, \"popupWidth\": { \"value\": 600 } } }, \"ordinal\": 40 } ], \"objectType\": \"WT.WorkItem.Actions\" } ], \"adapter\": { \"instanceName\": \"windchill\", \"thingName\": \"PTC.WCAdapter\" } } ] } } }"
}
}
},
"showSecondaryIcon": {
"value": false
},
"baseConfigurationVersion": {
"value": "9.0.0"
},
"implementationConfigurationVersion": {
"value": "9.0.0"
},
"secondaryTitle": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"numericIdentifier": 1,
"id": "Activity|Name",
"ordinal": 0
}
],
"objectType": "PTC.Workflow.WorkItem"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
},
"pattern": "%1"
},
"attributes": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"id": "Role#Display",
"ordinal": 0
},
{
"id": "Activity|Deadline",
"ordinal": 1
},
{
"id": "Status#Display",
"ordinal": 2
}
],
"objectType": "PTC.Workflow.WorkItem"
},
{
"items": [
{
"id": "Category#Display",
"ordinal": 3
},
{
"id": "RequestPriority#Display",
"ordinal": 4
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
},
"showImage": {
"value": false
}
}
Returns:
{
"enableActionBar": true,
"items": {
"timeStamp": "2020-05-29 11:46:01.901",
"data": [
{
"itemListsData": [
{
"metadata": {
"Role#Display": {
"label": "Role",
"type": "STRING"
},
"Activity|Deadline": {
"label": "Due Date",
"type": "DATETIME"
},
"ID": {
"label": "ID",
"type": "STRING"
},
"Status#Display": {
"label": "Status",
"type": "STRING"
},
"Activity|Name": {
"label": "Name",
"type": "STRING"
},
"Subject|SubjectName": {
"label": "Subject Name",
"type": "STRING"
}
},
"items": [
{
"Role#Display": {
"value": "Manufacturing Manager"
},
"Activity|Deadline": {
"value": ""
},
"ID": {
"value": "OR:wt.workflow.work.WorkItem:326525"
},
"Status#Display": {
"value": "Potential"
},
"Activity|Name": {
"value": "Conduct Online CRB Review"
},
"Subject|SubjectName": {
"value": "Change Request - 00009,MYCR77"
}
}
],
"objectType": "PTC.Workflow.WorkItem"
},
{
"metadata": {
"Category#Display": {
"label": "Category",
"type": "STRING"
},
"ID": {
"label": "ID",
"type": "STRING"
},
"RequestPriority#Display": {
"label": "Request Priority",
"type": "STRING"
}
},
"items": [
{
"Category#Display": {
"value": "Cost Reduction"
},
"ID": {
"value": "OR:wt.change2.WTChangeRequest2:324549"
},
"RequestPriority#Display": {
"value": "Low"
}
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"statusMessage": "OK",
"status": "200"
}
}
GetItems
Parameters:
configuration:
{
"actionBarConfiguration": {
"value": {
"actionBarConfigurationJSON": {
"value": "{\"maxItemsToShow\": {\"value\": 2},\"modelThingName\": {\"entityName\": \"PTC.ActionBarModel.Thing\"},\"actions\": {\"selectedValues\": {\"data\": [{\"itemListsData\": [{\"items\": [{\"id\": \"Reassign\",\"additionalData\": {\"actionConfiguration\": {\"iconWhenDisabled\": {\"entityName\": \"PTC.ActionBar.ReassignDisabledIcon\"},\"iconWhenHovered\": {\"entityName\": \"PTC.ActionBar.ReassignHoverIcon\"},\"overrideLabel\": {\"value\": \"[[PTC.Nav.TaskList.TaskReassignLabel]]\"},\"popupHeight\": {\"value\": 579},\"inputConstraints\": {\"selectedKey\": \"InputRequired\"},\"actionButtonVisibility\": {\"selectedKey\": \"AlwaysShown\"},\"buttonStyle\": {\"selectedKey\": \"transparent\"},\"mashupName\": {\"mashupName\": \"PTC.AccessApp.WindchillServices.ReassignActionMashup\"},\"fireEventOnFinish\": {\"value\": false},\"activityType\": {\"selectedKey\": \"popup\"},\"iconWhenEnabled\": {\"entityName\": \"PTC.ActionBar.ReassignIcon\"},\"popupWidth\": {\"value\": 600}}},\"ordinal\": 0}],\"objectType\": \"WT.WorkItem.Actions\"}],\"adapter\": {\"instanceName\": \"windchill\",\"thingName\": \"PTC.WCAdapter\"}}]}}}"
}
}
},
"implementationConfiguration": {
"value": {
"taskTypeFilter": {
"value": "[{\"activityName\": \"Conduct Online CRB Review\",\"workItemProcessTemplate\": \"Change Request Workflow\"}]"
}
}
},
"defaultSortFields": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"additionalData": {
"itemListDefaultSortFieldDefinition": {
"defaultSortDirection": {
"selectedKey": "asc"
}
}
},
"id": "Activity|Deadline"
}
],
"objectType": "PTC.Workflow.WorkItem"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
},
"filterFields": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"additionalData": {
"itemListFilterFieldDefinition": {
"filterLabelOverride": {
"value": "[[PTC.Nav.TaskList.Status]]"
},
"defaultSelectedFilterValues": {
"filters": {
"filters": [
{
"fieldName": "",
"type": "EQ",
"value": "POTENTIAL"
},
{
"fieldName": "",
"type": "EQ",
"value": "ACCEPTED"
}
],
"type": "Or"
}
}
}
},
"id": "Status#Display",
"ordinal": 0
}
],
"objectType": "PTC.Workflow.WorkItem"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
},
"label": {
"value": "[[PTC.Nav.TaskList.Label]]"
},
"showExportAction": {
"value": true
},
"selectionType": {
"selectedKey": "multi"
},
"waitForInput": {
"value": false
},
"baseConfigurationVersion": {
"value": "9.0.0"
},
"implementationConfigurationVersion": {
"value": "9.0.0"
},
"attributes": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
},
"implementationAttributesDefinition": {
"linkToMashup": {
"mashupName": "PTC.CRDetailedReviewAppMashup"
}
}
},
"id": "Activity|Name",
"ordinal": 0
},
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
}
},
"id": "Subject|SubjectName",
"ordinal": 1
},
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
}
},
"id": "Activity|Deadline",
"ordinal": 2
},
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
}
},
"id": "Status#Display",
"ordinal": 3
},
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
}
},
"id": "Activity|Context|Name",
"ordinal": 4
}
],
"objectType": "PTC.Workflow.WorkItem"
},
{
"items": [
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": "PTC.Nav.TaskList.TaskProgress"
}
}
},
"id": "TaskProgress",
"ordinal": 5
}
],
"objectType": "PTC.Workflow.WorkItem.Custom.Implementation"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
},
"enableSearch": {
"additionalData": {
"itemListSearchDefinition": {
"searchHintText": {
"value": "[[PTC.Nav.TaskList.FindHintText]]"
}
}
},
"value": true
},
"maxNumberOfRowsInGrid": {
"value": 500
}
}
Returns:
{
"timeStamp": "2020-05-31 10:28:58.559",
"data": [
{
"itemListsData": [
{
"metadata": {
"Activity|Context|Name": {
"label": "Context Name",
"type": "STRING"
},
"Activity|Deadline": {
"label": "Due Date",
"type": "DATETIME"
},
"ID": {
"label": "ID",
"type": "STRING"
},
"TaskProgress": {
"format": "unsanitized",
"label": "Task Progress",
"type": "html"
},
"Activity|Name": {
"label": "Name",
"type": "html"
},
"Status#Display": {
"label": "Status",
"type": "STRING"
},
"Subject|SubjectName": {
"label": "Subject Name",
"type": "STRING"
}
},
"items": [
{
"Activity|Context|Name": {
"value": "GOLF_CART"
},
"Activity|Deadline": {
"value": ""
},
"ID": {
"value": "OR:wt.workflow.work.WorkItem:143921"
},
"TaskProgress": {
"value": "<ptc-nav-progress-bar steps=[4,3] message=[[PTC.Nav.TaskList.NumberOfRespondedMembers]]></ptc-nav-progress-bar>"
},
"Activity|Name": {
"value": "<a gridSortValue=\"Conduct Online CRB Review\" href=\"index.html?mashup=PTC.CRDetailedReviewAppMashup&TaskID=OR:wt.workflow.work.WorkItem:143921\" >Conduct Online CRB Review</a>"
},
"Status#Display": {
"value": "Completed"
},
"Subject|SubjectName": {
"value": "Change Request - 00003,Improve mechanism of changing cart height"
}
},
{
"Activity|Context|Name": {
"value": "GOLF_CART"
},
"Activity|Deadline": {
"value": ""
},
"ID": {
"value": "OR:wt.workflow.work.WorkItem:143928"
},
"TaskProgress": {
"value": "<ptc-nav-progress-bar steps=[4,3] message=[[PTC.Nav.TaskList.NumberOfRespondedMembers]]></ptc-nav-progress-bar>"
},
"Activity|Name": {
"value": "<a gridSortValue=\"Conduct Online CRB Review\" href=\"index.html?mashup=PTC.CRDetailedReviewAppMashup&TaskID=OR:wt.workflow.work.WorkItem:143921\" >Conduct Online CRB Review</a>"
},
"Status#Display": {
"value": "Completed"
},
"Subject|SubjectName": {
"value": "Change Request - 00003,Improve mechanism of changing cart height"
}
}
],
"objectType": "PTC.Workflow.WorkItem"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"statusMessage": "OK",
"status": "200"
}
InitializeFilters
Parameters:
configuration:
{
"actionBarConfiguration": {
"value": {
"actionBarConfigurationJSON": {
"value": "{\"maxItemsToShow\": {\"value\": 2},\"modelThingName\": {\"entityName\": \"PTC.ActionBarModel.Thing\"},\"actions\": {\"selectedValues\": {\"data\": [{\"itemListsData\": [{\"items\": [{\"id\": \"Reassign\",\"additionalData\": {\"actionConfiguration\": {\"iconWhenDisabled\": {\"entityName\": \"PTC.ActionBar.ReassignDisabledIcon\"},\"iconWhenHovered\": {\"entityName\": \"PTC.ActionBar.ReassignHoverIcon\"},\"overrideLabel\": {\"value\": \"[[PTC.Nav.TaskList.TaskReassignLabel]]\"},\"popupHeight\": {\"value\": 579},\"inputConstraints\": {\"selectedKey\": \"InputRequired\"},\"actionButtonVisibility\": {\"selectedKey\": \"AlwaysShown\"},\"buttonStyle\": {\"selectedKey\": \"transparent\"},\"mashupName\": {\"mashupName\": \"PTC.AccessApp.WindchillServices.ReassignActionMashup\"},\"fireEventOnFinish\": {\"value\": false},\"activityType\": {\"selectedKey\": \"popup\"},\"iconWhenEnabled\": {\"entityName\": \"PTC.ActionBar.ReassignIcon\"},\"popupWidth\": {\"value\": 600}}},\"ordinal\": 0}],\"objectType\": \"WT.WorkItem.Actions\"}],\"adapter\": {\"instanceName\": \"windchill\",\"thingName\": \"PTC.WCAdapter\"}}]}}}"
}
}
},
"implementationConfiguration": {
"value": {
"taskTypeFilter": {
"value": "[{\"activityName\": \"Conduct Online CRB Review\",\"workItemProcessTemplate\": \"Change Request Workflow\"}]"
}
}
},
"defaultSortFields": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"additionalData": {
"itemListDefaultSortFieldDefinition": {
"defaultSortDirection": {
"selectedKey": "asc"
}
}
},
"id": "Activity|Deadline"
}
],
"objectType": "PTC.Workflow.WorkItem"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
},
"filterFields": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"additionalData": {
"itemListFilterFieldDefinition": {
"filterLabelOverride": {
"value": "[[PTC.Nav.TaskList.Status]]"
},
"defaultSelectedFilterValues": {
"filters": {
"filters": [
{
"fieldName": "",
"type": "EQ",
"value": "POTENTIAL"
},
{
"fieldName": "",
"type": "EQ",
"value": "ACCEPTED"
}
],
"type": "Or"
}
}
}
},
"id": "Status#Display",
"ordinal": 0
}
],
"objectType": "PTC.Workflow.WorkItem"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
},
"label": {
"value": "[[PTC.Nav.TaskList.Label]]"
},
"showExportAction": {
"value": true
},
"selectionType": {
"selectedKey": "multi"
},
"waitForInput": {
"value": false
},
"baseConfigurationVersion": {
"value": "9.0.0"
},
"implementationConfigurationVersion": {
"value": "9.0.0"
},
"attributes": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
},
"implementationAttributesDefinition": {
"linkToMashup": {
"mashupName": "PTC.CRDetailedReviewAppMashup"
}
}
},
"id": "Activity|Name",
"ordinal": 0
},
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
}
},
"id": "Subject|SubjectName",
"ordinal": 1
},
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
}
},
"id": "Activity|Deadline",
"ordinal": 2
},
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
}
},
"id": "Status#Display",
"ordinal": 3
},
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": ""
}
}
},
"id": "Activity|Context|Name",
"ordinal": 4
}
],
"objectType": "PTC.Workflow.WorkItem"
},
{
"items": [
{
"additionalData": {
"itemListAttributesDefinition": {
"fieldTitleOverride": {
"value": "PTC.Nav.TaskList.TaskProgress"
}
}
},
"id": "TaskProgress",
"ordinal": 5
}
],
"objectType": "PTC.Workflow.WorkItem.Custom.Implementation"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
},
"enableSearch": {
"additionalData": {
"itemListSearchDefinition": {
"searchHintText": {
"value": "[[PTC.Nav.TaskList.FindHintText]]"
}
}
},
"value": true
},
"maxNumberOfRowsInGrid": {
"value": 500
}
}
Returns:
{
"data": [
{
"itemListsData": [
{
"items": [
{
"id": "Status#Display",
"type": {
"enum": {
"options": [
{
"description": "",
"label": "Potential",
"key": "POTENTIAL"
},
{
"description": "",
"label": "Accepted",
"key": "ACCEPTED"
},
{
"description": "",
"label": "Completed",
"key": "COMPLETED"
}
]
}
}
}
],
"objectType": "PTC.Workflow.WorkItem"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
ProcessAttributesConfiguration
Parameters:
Sample for configuration is from Tiles.
attributes:
{
"timeStamp": "2020-01-30 12:54:30.014",
"data": [
{
"itemListsData": [
{
"items": [
{
"Name": {
"value": ""
},
"Number": {
"value": ""
}
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest"
},
{
"items": [
{
"Additional_Attr1": {
"value": ""
},
"Additional_Attr2": {
"value": ""
}
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest.Custom.Implementation"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
configuration:
{
"baseConfigurationVersion": {
"value": "9.0.0"
},
"implementationConfigurationVersion": {
"value": "9.0.0"
},
"attributes": {
"selectedValues": {
"data": [
{
"itemListsData": [
{
"items": [
{
"id": "Name",
"ordinal": 0
},
{
"id": "Number",
"ordinal": 1
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest"
},
{
"items": [
{
"id": "Additional_Attr1",
"ordinal": 3
},
{
"id": "Additional_Attr2",
"ordinal": 4
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest.Custom.Implementation"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
]
}
},
"maxTileCount": {
"value": "10"
}
}
Returns:
{
"OOTBAttributes": {
"timeStamp": "2020-05-28 17:38:38.231",
"data": [
{
"itemListsData": [
{
"items": [
{
"Number": {
"value": ""
},
"Name": {
"value": ""
}
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"statusMessage": "OK",
"status": "200"
},
"additionalAttributes": {
"timeStamp": "2020-05-28 17:38:38.231",
"data": [
{
"itemListsData": [
{
"items": [
{
"Additional_Attr2": {
"value": ""
},
"Additional_Attr1": {
"value": ""
}
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest.Custom.Implementation"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"statusMessage": "OK",
"status": "200"
}
}
UpdateAvailableAttributes
Parameters:
attributesCCO:
{
"timeStamp": "2020-05-29 11:44:12.68",
"data": [
{
"itemListsData": [
{
"metadata": {
"Category#Display": {
"label": "Category",
"type": "STRING"
},
"RequestPriority#Display": {
"label": "Request Priority",
"type": "STRING"
},
"Name": {
"label": "Name",
"type": "STRING"
},
"LastModified": {
"label": "Last Modified",
"type": "DATETIME"
}
},
"items": [
{
"Category#Display": {
"value": ""
},
"RequestPriority#Display": {
"value": ""
},
"Name": {
"value": ""
},
"LastModified": {
"value": ""
}
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"statusMessage": "OK",
"status": "200"
}
Returns:
{
"timeStamp": "2020-05-29 11:45:12.604",
"data": [
{
"itemListsData": [
{
"metadata": {
"Category#Display": {
"label": "Category",
"type": "STRING"
},
"RequestPriority#Display": {
"label": "Request Priority",
"type": "STRING"
},
"Name": {
"label": "Name",
"type": "STRING"
}
},
"items": [
{
"Category#Display": {
"value": ""
},
"RequestPriority#Display": {
"value": ""
},
"Name": {
"value": ""
}
}
],
"objectType": "PTC.ChangeMgmt.ChangeRequest"
}
],
"adapter": {
"instanceName": "windchill",
"thingName": "PTC.WCAdapter"
}
}
],
"statusMessage": "OK",
"status": "200"
}