PolicyCenter Job API (1.11.0)

APIs for job related objects

Create a new activity associated with this job

Create a new activity associated with this job (Since 1.1.0)

gw-childResourceType: Activity

gw-resourceType: JobActivities

gw-sinceVersion: 1.1.0

Authorizations:

basicAuth

path Parameters

jobId

required

string

The identifier for the job

query Parameters

fields

Array of strings

gw-allowForCompositeApi: true

Allows the caller to specify the set of fields that should be included on the response. This can be used to limit the set of fields returned as well as to include optional fields that otherwise wouldn't normally be returned. The parameter is either of the form fields=<field list> or fields=<include>:<field list>, where <field list> consists of a comma-separated list of field or field set names. See the documentation for more information.

Request Body schema: application/json

required	object (ActivityData)
	object (ActivityRequestInclusions)

Responses

Request samples

Payload

Content type

application/json

{"data": {"attributes": {"account": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"accountContact": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"activityPattern": "string",
"activityType": {"code": "string",
"name": "string"
},
"approvalIssue": "string",
"approvalRationale": "string",
"assignedByUser": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"assignedGroup": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"assignedQueue": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"assignedUser": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"assignmentStatus": {"code": "string",
"name": "string"
},
"associatedRole": {"code": "string",
"name": "string"
},
"closeUser": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"contact": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"contingency": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"description": "string",
"dueDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"escalationDate": "2019-08-24T14:15:22Z",
"externallyOwned": true,
"initialAssignment": {"autoAssign": true,
"groupId": "string",
"queueId": "string",
"role": {"code": "string",
"name": "string"
},
"userId": "string"
},
"job": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"mandatory": true,
"policy": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"priority": {"code": "string",
"name": "string"
},
"recurring": true,
"startDate": "2019-08-24T14:15:22Z",
"status": {"code": "string",
"name": "string"
},
"subject": "string"
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "string",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"uri": "string"
},
"included": {"Note": [{"attributes": {"account": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"author": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"body": "string",
"confidential": true,
"contingency": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"job": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"policy": {"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"securityType": {"code": "string",
"name": "string"
},
"subject": "string",
"topic": {"code": "string",
"name": "string"
}
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "string",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"uri": "string"
}
]
}
}

Response samples

Content type

application/json

{"data": {"attributes": {"account": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"accountContact": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"activityPattern": "string",
"activityType": {"code": "string",
"name": "string"
},
"approvalIssue": "string",
"approvalRationale": "string",
"approved": true,
"assignedByUser": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"assignedGroup": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"assignedQueue": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"assignedUser": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"assignmentStatus": {"code": "string",
"name": "string"
},
"associatedRole": {"code": "string",
"name": "string"
},
"closeDate": "2019-08-24T14:15:22Z",
"closeUser": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"contact": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"contingency": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"createTime": "2019-08-24T14:15:22Z",
"description": "string",
"dueDate": "2019-08-24T14:15:22Z",
"endDate": "2019-08-24T14:15:22Z",
"escalated": true,
"escalationDate": "2019-08-24T14:15:22Z",
"externallyOwned": true,
"id": "string",
"initialAssignment": {"assigneeId": "string",
"autoAssign": true,
"groupId": "string",
"name": "string",
"queueId": "string",
"role": {"code": "string",
"name": "string"
},
"userId": "string"
},
"job": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"mandatory": true,
"policy": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"priority": {"code": "string",
"name": "string"
},
"recurring": true,
"startDate": "2019-08-24T14:15:22Z",
"status": {"code": "string",
"name": "string"
},
"subject": "string"
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "string",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
},
"included": {"Assignee": [{"attributes": {"assigneeId": "string",
"autoAssign": true,
"groupId": "string",
"name": "string",
"queueId": "string",
"role": {"code": "string",
"name": "string"
},
"userId": "string"
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "string",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
}
],
"Note": [{"attributes": {"account": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"author": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"body": "string",
"bodySummary": "string",
"confidential": true,
"contingency": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"createdDate": "2019-08-24T14:15:22Z",
"id": "string",
"job": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"policy": {"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
},
"securityType": {"code": "string",
"name": "string"
},
"subject": "string",
"topic": {"code": "string",
"name": "string"
},
"updateTime": "2019-08-24T14:15:22Z"
},
"checksum": "string",
"id": "string",
"links": {"property1": {"href": "string",
"methods": ["string"
]
},
"property2": {"href": "string",
"methods": ["string"
]
}
},
"method": "string",
"refid": "string",
"related": {"property1": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
},
"property2": {"count": 0,
"data": [{"displayName": "string",
"id": "string",
"jsonPath": "string",
"refid": "string",
"type": "string",
"uri": "string"
}
],
"total": 0
}
},
"type": "string",
"uri": "string"
}
]
}
}

Was this page helpful?