ProRoster - Update the status of an AI Auto assignment simulation

API Url

Used to update the status of an AI Auto assignment simulation

PUT

http://localhost:16010/ProMarkREST/web/ProRoster/plans/{planId}/automations

Permissions: user

Path parameters

Field	Type	Description
id	Number	The plan Id.

Parameter

Field	Type	Description
request	Object	Main object containing the request data.
data	Object	Object containg data to be uploaded.
status	Object[]
from	Date	Start Date of the simulation
id	Number	Id of the simulation
planId	Number	Unique id of the plan
read	Boolean	True if the status was read
snapshotVersion	Number	The Id of the snapshot where the auto assignment will be saved.
started	DateTime	The date and time of when the simulation was started.
to	Date	End Date of the simulation

Success 200

Field	Type	Description
response	Object	Main object containing the response data.
status	Object[]
from	Date	Start Date of the simulation
id	Number	Id of the simulation
planId	Number	Unique id of the plan
read	Boolean	True if the status was read
snapshotVersion	Number	The Id of the snapshot where the auto assignment will be saved.
started	DateTime	The date and time of when the simulation was started.
to	Date	End Date of the simulation
message`optional`	Object	Object containing response messages.
code	Number	Message code.
text	String	Message text.
type	String	Type of message. Allowed values:`"warning""info"`

Success example with a single shift:

HTTP/1.1 200 OK
{
   "response": {
      "data": {
         "status": [
             {
                 "id": 21321354,
                 "from": "2021-11-04",
                 "to": "2021-11-11",
                 "planId": 132130,
                 "read": false,
                 "snapshotVersion": 1,
                 "started" : 2021-11-04 10:30:00 
             }
         ]   
      },
      "erorCode": 0,
      "errorMessage": ""
   }
}