Show Source

• addByUserId: integer(int64)
  Read Only: true

  The username of the user who added the item.
• applicationUserId: integer(int64)
  Read Only: true

  The system-generated identifier of a user.
• commitmentId(optional): integer(int64)
  Read Only: true

  The unique identifier of a commitment.
• dueDate: string(date-time)
  The date by which the task is expected to be completed.
• link(optional): string(url)
  Read Only: true
• projectCompanyId: integer(int64)
  The system-generated identifier of a project.
• projectId: integer(int64)
  The system-generated identifier of a project.
• reasons(optional): array reasons
  Read Only: true

  Unique Items Required: true
• status(optional): string
  Read Only: true

  Allowed Values: [ "COMMITTED", "RECOMMITTED" ]

  The status of the commitment. Valid values are Committed and Recommitted.
• timezoneDateAdded(optional): object TimezoneSensitiveDateTime
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
• workManagerTaskId: integer(int64)
  Read Only: true

  The unique identifier of a task.

{
    "type":"object",
    "required":[
        "addByUserId",
        "applicationUserId",
        "dueDate",
        "projectCompanyId",
        "projectId",
        "workManagerTaskId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "status":{
            "type":"string",
            "description":"The status of the commitment. Valid values are Committed and Recommitted.",
            "readOnly":true,
            "enum":[
                "COMMITTED",
                "RECOMMITTED"
            ]
        },
        "commitmentId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a commitment.",
            "readOnly":true
        },
        "dueDate":{
            "type":"string",
            "format":"date-time",
            "description":"The date by which the task is expected to be completed."
        },
        "reasons":{
            "type":"array",
            "readOnly":true,
            "uniqueItems":true,
            "items":{
                "$ref":"#/definitions/ApiEntityReason"
            }
        },
        "projectId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a project."
        },
        "projectCompanyId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a project."
        },
        "addByUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The username of the user who added the item.",
            "readOnly":true
        },
        "applicationUserId":{
            "type":"integer",
            "format":"int64",
            "description":"The system-generated identifier of a user.",
            "readOnly":true
        },
        "timezoneDateAdded":{
            "description":"The date by which the commitment was added.",
            "readOnly":true,
            "$ref":"#/definitions/TimezoneSensitiveDateTime"
        },
        "workManagerTaskId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a task.",
            "readOnly":true
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Show Source

• [0]: object ApiEntityReason

{
    "type":"array",
    "readOnly":true,
    "uniqueItems":true,
    "items":{
        "$ref":"#/definitions/ApiEntityReason"
    }
}

Show Source

• wrappedDateTime(optional): string(date-time)

{
    "type":"object",
    "properties":{
        "wrappedDateTime":{
            "type":"string",
            "format":"date-time"
        }
    }
}

Show Source

• abbreviation: string
  The abbreviation of the reason for recommitting to a task.
• appliesTo(optional): array appliesTo
  The type of the reason.
• link(optional): string(url)
  Read Only: true
• pushDownType(optional): string
  Allowed Values: [ "MANUAL", "AUTOMATIC" ]

  How data is shared between parent and child workspaces.
  Manual: Data can be pulled down by child workspaces. This is the default option.
  Automatic: Data is automatically shared with all child workspaces.
• reasonId(optional): integer(int64)
  The unique identifier of a reason.
• reasonName: string
  The name of the reason for recommitting to a task.
• updateDate(optional): string(date-time)
  Read Only: true

  Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.
• workspaceId: integer(int64)
  The unique identifier of a workspace.

{
    "type":"object",
    "required":[
        "abbreviation",
        "reasonName",
        "workspaceId"
    ],
    "properties":{
        "link":{
            "type":"string",
            "format":"url",
            "readOnly":true
        },
        "workspaceId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a workspace."
        },
        "pushDownType":{
            "type":"string",
            "description":"How data is shared between parent and child workspaces. <br />Manual: Data can be pulled down by child workspaces. This is the default option. <br />Automatic: Data is automatically shared with all child workspaces.",
            "enum":[
                "MANUAL",
                "AUTOMATIC"
            ]
        },
        "abbreviation":{
            "type":"string",
            "description":"The abbreviation of the reason for recommitting to a task."
        },
        "reasonName":{
            "type":"string",
            "description":"The name of the reason for recommitting to a task."
        },
        "reasonId":{
            "type":"integer",
            "format":"int64",
            "description":"The unique identifier of a reason."
        },
        "appliesTo":{
            "type":"array",
            "description":"The type of the reason.",
            "items":{
                "type":"string",
                "enum":[
                    "TASKS",
                    "CHANGE_EVENT"
                ]
            }
        },
        "updateDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date when the record was last updated. Used for viewing and filtering records, obtained ONLY from GET calls, modified on and after a particular date. Not a part of POST response.",
            "readOnly":true
        }
    }
}

Show Source

• [0]: string
  Allowed Values: [ "TASKS", "CHANGE_EVENT" ]

{
    "type":"array",
    "description":"The type of the reason.",
    "items":{
        "type":"string",
        "enum":[
            "TASKS",
            "CHANGE_EVENT"
        ]
    }
}