Platform | Assignment

Service to manage entities of type 'Assignment'.

Overview

api/{tenantKey}/{orgKey}/corePatterns/assignments

URL	api/{tenantKey}/{orgKey}/corePatterns/assignments
Methods Supported	GET, POST, PUT, DELETE

All Operations

This service includes the following operations:

GET:
POST:
- POST Assignments
- POST Assignment
PUT:
DELETE:

All Resources

This service uses the following resources:

ApiAssignmentAssignmentStepsResource
ApiAssignmentResource
AssignmentResource
AssignmentStepResource

All Enumerations

This service uses the following enumerations:

AssignmentState

GET Operations

GET Assignments

Returns the list of all the entity records available.

Response:

When successful, the response body contains the list of records available. See AssignmentResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments

GET /corePatterns/assignments

GET Assignments (paged)

Returns a page of the list of all the entity records available.

The following elements are optional:

page	(int) The index of the page of the list that should be returned. This is a query string parameter.
pageSize	(int) The number of page elements that should be returned (max. is 1000). This is a query string parameter.

Response:

When successful, the response body contains the list of records available. See AssignmentResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments?page={page}&pageSize={pageSize}

GET /corePatterns/assignments?page={page}&pageSize={pageSize}

GET Assignment by identifier

Returns the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body contains the entity record. See AssignmentResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{id}

GET /corePatterns/assignments/{id}

GET Assignment by key

Returns the entity record that matches the specified key.

The following elements are required:

assignmentKey

(int) Assignment.

Response:

When successful, the response body contains the entity record. See AssignmentResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}

GET /corePatterns/assignments/{assignmentKey}

GET Print Assignment by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{id}/print?template={template}

GET /corePatterns/assignments/{id}/print?template={template}

GET Print Assignment by key

Prints the specified entity record.

The following elements are required:

assignmentKey

(int) Assignment.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/print

GET /corePatterns/assignments/{assignmentKey}/print

GET Original Print AssignmentOriginal by identifier

Prints the specified entity record.

The following elements are required:

id	(string) The record identifier.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
404	NotFound. The specified resord does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{id}/printOriginal?template={template}

GET /corePatterns/assignments/{id}/printOriginal?template={template}

GET Original Print Assignment by key

Prints the specified entity record.

The following elements are required:

assignmentKey

(int) Assignment.

The following elements are optional:

template

(string) The report template that should be used. This is a query string parameter.

Response:

When successful, the response body contains a stream with the printed file.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/printOriginal

GET /corePatterns/assignments/{assignmentKey}/printOriginal

GET Get Assignments Between Dates

Custom operation 'GetAssignmentsBetweenDates'.

The following elements are required:

startDate	(DateTimeOffset) StartDate.
endDate	(DateTimeOffset) EndDate.

Response:

When successful, the response body contains a list of resources of type 'AssignmentResource'. See AssignmentResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/getAssignmentsBetweenDates

GET /corePatterns/assignments/getAssignmentsBetweenDates

GET Get Assignments Due Today

Custom operation 'GetAssignmentsDueToday'.

Response:

When successful, the response body contains a list of resources of type 'AssignmentResource'. See AssignmentResource.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/getAssignmentsDueToday

GET /corePatterns/assignments/getAssignmentsDueToday

POST Operations

POST Assignments

Creates a new entity record.

The following elements are required:

assignmentResource

(ApiAssignmentResource) The request body should contain the entity record that should be created.
See ApiAssignmentResource.

Response:

When successful, the response body contains the new entity record identifier. The resource header location property contains the URL for the new entity record. See ApiAssignmentResource.

Response status codes:

201	Created. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments

POST /corePatterns/assignments

POST Assignment

Inserts a new 'Assignment Step' in the 'Assignment'.

The following elements are required:

assignmentKey	(int) Assignment.
value	(ApiAssignmentAssignmentStepsResource) The ApiAssignmentAssignmentStepsResource instance. See ApiAssignmentAssignmentStepsResource.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/assignmentSteps

POST /corePatterns/assignments/{assignmentKey}/assignmentSteps

PUT Operations

PUT Set AssignedTo Assignment

Updates the value of attribute 'AssignedTo' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/assignedTo

PUT /corePatterns/assignments/{assignmentKey}/assignedTo

PUT Set AssignedTo AssignmentStep

Updates the value of attribute 'AssignedTo' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/assignedTo

PUT /corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/assignedTo

PUT Set AssignedToDescription Assignment

Updates the value of attribute 'AssignedToDescription' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/assignedToDescription

PUT /corePatterns/assignments/{assignmentKey}/assignedToDescription

PUT Set AssignedToDescription AssignmentStep

Updates the value of attribute 'AssignedToDescription' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/assignedToDescription

PUT /corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/assignedToDescription

PUT Set AssignedToKey Assignment

Updates the value of attribute 'AssignedToKey' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/assignedToKey

PUT /corePatterns/assignments/{assignmentKey}/assignedToKey

PUT Set AssignedToKey AssignmentStep

Updates the value of attribute 'AssignedToKey' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/assignedToKey

PUT /corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/assignedToKey

PUT Set AssignmentState Assignment

Updates the value of attribute 'AssignmentState' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
value	(enum AssignmentState) The request body should contain the new value for the attribute. See AssignmentState.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/assignmentState

PUT /corePatterns/assignments/{assignmentKey}/assignmentState

PUT Set AssignmentState AssignmentStep

Updates the value of attribute 'AssignmentState' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
lineId	(string) The detail identifier.
value	(enum AssignmentState) The request body should contain the new value for the attribute. See AssignmentState.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/assignmentState

PUT /corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/assignmentState

PUT Set Completed AssignmentStep

Updates the value of attribute 'Completed' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
lineId	(string) The detail identifier.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/completed

PUT /corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/completed

PUT Set DueDate Assignment

Updates the value of attribute 'DueDate' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
value	(DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/dueDate

PUT /corePatterns/assignments/{assignmentKey}/dueDate

PUT Set DueDate AssignmentStep

Updates the value of attribute 'DueDate' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
lineId	(string) The detail identifier.
value	(DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/dueDate

PUT /corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/dueDate

PUT Set IsActive Assignment

Updates the value of attribute 'IsActive' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
value	(bool) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/isActive

PUT /corePatterns/assignments/{assignmentKey}/isActive

PUT Set Notes Assignment

Updates the value of attribute 'Notes' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/notes

PUT /corePatterns/assignments/{assignmentKey}/notes

PUT Set Reminder Assignment

Updates the value of attribute 'Reminder' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
value	(DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/reminder

PUT /corePatterns/assignments/{assignmentKey}/reminder

PUT Set Reminder AssignmentStep

Updates the value of attribute 'Reminder' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
lineId	(string) The detail identifier.
value	(DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/reminder

PUT /corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/reminder

PUT Set StartDate Assignment

Updates the value of attribute 'StartDate' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
value	(DateTimeOffset) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/startDate

PUT /corePatterns/assignments/{assignmentKey}/startDate

PUT Set Title Assignment

Updates the value of attribute 'Title' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/title

PUT /corePatterns/assignments/{assignmentKey}/title

PUT Set Title AssignmentStep

Updates the value of attribute 'Title' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/title

PUT /corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/title

PUT Set Url Assignment

Updates the value of attribute 'Url' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/url

PUT /corePatterns/assignments/{assignmentKey}/url

PUT Set Url AssignmentStep

Updates the value of attribute 'Url' in the specified entity record.

The following elements are required:

assignmentKey	(int) Assignment.
lineId	(string) The detail identifier.
value	(string) The request body should contain the new value for the attribute.

Response:

When successful, the response body is empty.

Response status codes:

200	OK. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/url

PUT /corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}/url

DELETE Operations

DELETE Assignment Step by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

assignmentKey	(int) Assignment.
lineId	(string) The line identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	NoContent. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}

DELETE /corePatterns/assignments/{assignmentKey}/assignmentSteps/{lineId}

DELETE Assignment by identifier

Deletes the entity record that matches the specified identifier.

The following elements are required:

id	(string) The record identifier.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{id}

DELETE /corePatterns/assignments/{id}

DELETE Assignment by key

Deletes the entity record that matches the specified key.

The following elements are required:

assignmentKey

(int) Assignment.

Response:

When successful, the response body is empty.

Response status codes:

204	Deleted. The operation was completed successfully.
400	BadRequest. The request parameters are invalid.
404	NotFound. The specified record does not exist.

Resource URL:

api/{tenantKey}/{orgKey}/corePatterns/assignments/{assignmentKey}

DELETE /corePatterns/assignments/{assignmentKey}

Resources

ApiAssignmentAssignmentStepsResource

The following elements are required:

title	(string) Title.
assignedTo	(string) Assigned To.
dueDate	(DateTimeOffset) Due Date.
completed	(bool) Completed.
assignmentState	(enum AssignmentState) Step State. See AssignmentState.

The following elements are optional:

reminder	(DateTimeOffset) Reminder.
url	(string) Url.
assignedToDescription	(string) Assigned To.
assignedToKey	(string) Assigned To.

ApiAssignmentResource

The following elements are required:

title	(string) Title.
assignedTo	(string) Assigned To.
dueDate	(DateTimeOffset) Due Date.
assignmentState	(enum AssignmentState) Assignment State. See AssignmentState.

The following elements are optional:

reminder	(DateTimeOffset) Reminder.
notes	(string) Notes.
url	(string) Url.
assignmentSteps	(List of ApiAssignmentAssignmentStepsResource) Assignment Steps. See ApiAssignmentAssignmentStepsResource.
startDate	(DateTimeOffset) Start Date.
assignedToDescription	(string) Assigned To.
assignedToKey	(string) Assigned To.

AssignmentResource

The following elements are required:

assignmentKey	(int) Assignment.
title	(string) Title.
assignedTo	(string) Assigned To.
dueDate	(DateTimeOffset) Due Date.
assignmentState	(enum AssignmentState) Assignment State. See AssignmentState.

The following elements are optional:

reminder	(DateTimeOffset) Reminder.
notes	(string) Notes.
url	(string) Url.
assignmentSteps	(List of AssignmentStepResource) Assignment Steps. See AssignmentStepResource.
startDate	(DateTimeOffset) Start Date.
assignedToDescription	(string) Assigned To.
assignedToKey	(string) Assigned To.

AssignmentStepResource

The following elements are required:

title	(string) Title.
assignedTo	(string) Assigned To.
dueDate	(DateTimeOffset) Due Date.
completed	(bool) Completed.
assignmentState	(enum AssignmentState) Step State. See AssignmentState.

The following elements are optional:

reminder	(DateTimeOffset) Reminder.
url	(string) Url.
assignedToDescription	(string) Assigned To.
assignedToKey	(string) Assigned To.

Enumerations

AssignmentState

1	NotStarted
2	InProgress
3	Stalled
4	Completed