CheckPoint

CheckPoint Service

Service for manipulating checkpoints in a project.

Get Check Points

GET /checkpoints/{projectID}

Return the checkpoints for the specified project.

Path Parameters:
NameTypeRequiredDescription
projectIDStringtrueID of the project containing the desired checkpoints
Query Parameters:
NameTypeRequiredDescription
countIntegerfalseMaximum number of checkpoints to be returned (default is 25)
startIndexIntegerfalseZero-relative offset of the first checkpoint to be returned (default is 0)
fieldsStringfalseFields to include in each returned CheckPoint
Retrieves:
  • CheckPoint[]
  • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)If an input field is missing or malformed
    409 (Conflict)if the given ID does not refer to a project
    403 (Forbidden)if you are not allowed to perform this operation
    404 (Not Found)if the specified project cannot be found

    Create Check Points

    POST /checkpoints/{projectID}

    Sets the checkpoints for the specified project. The list field must be an array of objects describing the complete list of checkpoints to apply to the project.

    The following fields are valid in each object of the list array in the incoming JSON entity :

    NameTypeDescriptionRequired
    descriptionStringThe description of the checkpointNo
    dueDateStringThe due date in ISO-8601 standard formatYes
    nameStringThe name of the checkpointYes
    Path Parameters:
    NameTypeRequiredDescription
    projectIDStringtrueID of the project that will have its checkpoints changed
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to include in each returned CheckPoint
    Takes:
  • A checkPoints field containing an array of objects describing the complete list of checkpoints for the project
  • Retrieves:
  • the list of updated CheckPoint for the project
  • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)The given ID does not refer to a project
    403 (Forbidden)You are not allowed to perform this operation
    404 (Not Found)The specified project cannot be found