Jasmin Developers - Web API Reference

GET Operations

GET Assignments (odata)

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

The following elements are optional:

opts (ODataQueryOptions) OData query option.

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:

GET /corePatterns/assignments/odata

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:

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:

GET /corePatterns/assignments/{assignmentKey}

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:

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:

GET /corePatterns/assignments/getAssignmentsDueToday

POST Operations

POST Assignment Step

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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:

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

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