WOworkramp

Create Path Assignment

Create an assignment for a given user

post/api/v1/paths/{path_id}/assignments

Request

  • Base URL
    https://app.workramp.com
  • URL
    https://app.workramp.com/api/v1/paths/{path_id}/assignments
  • Auth
    API key in header Authorization

Path parameters

path_idstring required

ID of the path

Request body

userIdinteger required

ID of user to be assigned the Path

dueDatestring date-time

Flexible date format, with a preference for ISO8601 formats, but can accept number of milliseconds since 1970-01-01 00:00:00 UTC.

createdThroughstring

An optional string that helps tag or identify this path assignment. You will be able to filter any logs by this tag.

emailstring

Optionally pass in an email in case you don't know the userId

dueAtEndOfDayboolean

Specifies whether you want to have the due date set to 23:59:99 of the day chosen.

Response

200

idstring
userIdinteger
trainingSeriesIdstring
assignerIdinteger
dueDateinteger
isCompletedboolean
createdAtinteger
updatedAtinteger
createdThroughunknown
numModulesinteger
modulesCompletedinteger

Example response

{
  "id": "d11a0a34-b659-12e8-91fe-06cfa4e7b2f4",
  "userId": 2003132,
  "trainingSeriesId": "40afd844-fc64-21e6-8eb3-02dcdaae3a92",
  "assignerId": 133432,
  "dueDate": 1487900059000,
  "createdAt": 1536735724285,
  "updatedAt": 1536735724285,
  "numModules": 4,
  "modulesCompleted": 2
}

Changes

No recorded changes to this operation across all 1 revision of this API.