Outcome

Outcome Service

Web service endpoints for outcome entries.

Create Outcome

POST /outcomes/{outcomeID}/outcomes

Create a new outcome as a child of the existing outcome with the specified characteristics.

Path Parameters:
NameTypeRequiredDescription
outcomeIDStringtrueID of the comment being replied to
Query Parameters:
NameTypeRequiredDescription
fieldsStringfalseFields to include in the returned Outcome
Takes:
  • Outcome describing the new outcome comment to be created
    • Retrieves:
  • Outcome describing the new outcome
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)You attempted to add a comment to a content object that does not support them, or for which comments have been closed
    403 (Forbidden)You are not allowed to perform this operation
    404 (Not Found)The specified parent outcome object cannot be found

    Destroy Outcome

    DELETE /outcomes/{outcomeID}

    Delete the outcome of the specified outcome entry by the requesting user.

    Path Parameters:
    NameTypeRequiredDescription
    outcomeIDStringtrueID of the outcome for which a like is being removed
    Return Status:
    HTTP Status CodeDescription
    204 (No Content)Request was successful
    400 (Bad Request)An input field is malformed
    409 (Conflict)You do not currently have a like registered for this outcome
    403 (Forbidden)You are not allowed to access or unlike this outcome
    404 (Not Found)The specified outcome does not exist

    Get History

    GET /outcomes/{outcomeID}/history

    Get the history of the given outcome by following its parent outcomes.

    Path Parameters:
    NameTypeRequiredDescription
    outcomeIDStringtrueID of the comment being replied to
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to include in the returned Outcome
    Retrieves:
  • Outcome describing the new outcome
    • Return Status:
    HTTP Status CodeDescription
    201 (Created)Request was successful
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)You attempted to add a comment to a content object that does not support them, or for which comments have been closed
    403 (Forbidden)You are not allowed to perform this operation
    404 (Not Found)The specified parent outcome object cannot be found

    Get Outcome

    GET /outcomes/{outcomeID}

    Return the specified outcome entry with the specified fields.

    Path Parameters:
    NameTypeRequiredDescription
    outcomeIDStringtrueID of the outcome entry to be returned
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to be returned
    Retrieves:
  • Outcome containing the specified outcome
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is missing or malformed
    403 (Forbidden)You are not allowed to access the specified outcome
    404 (Not Found)The specified outcome does not exist

    Get Outcomes

    GET /outcomes

    Returns a paginated list of outcomes that were created by the requesting person.

    Query Parameters:
    NameTypeRequiredDescription
    startIndexIntegerfalseZero-relative index of the first outcome to be returned
    countIntegerfalseMaximum number of outcomes to be returned
    hiddenBooleanfalseInclude hidden/archieved in outcomes returned
    fieldsStringfalseFields to be returned on outcomes
    Takes:
  • filters
    • Retrieves:
  • Outcome containing the specified outcome
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is missing or malformed
    403 (Forbidden)You are not allowed to access the specified outcome

    Update Outcome

    PUT /outcomes/{outcomeID}

    Update the specified outcome with the specified characteristics.

    Path Parameters:
    NameTypeRequiredDescription
    outcomeIDStringtrueof the outcome to be updated
    Query Parameters:
    NameTypeRequiredDescription
    fieldsStringfalseFields to include in the returned entity
    Takes:
  • Outcome containing the updated outcome
    • Retrieves:
  • Outcome representing the updated comment
    • Return Status:
    HTTP Status CodeDescription
    200 (OK)Request was successful
    400 (Bad Request)An input field is missing or malformed
    409 (Conflict)You attempt to add a comment to a content object that does not support them, or for which comments have been closed
    403 (Forbidden)You are not allowed to access the specified outcome
    404 (Not Found)The specified comment does not exist