Error ServicesΒΆ

These services provide access to information about registered errors and error mappings.

Error List
Returns a list of all errors.
GET /errors/
Query Parameters
page Integer Optional The page of the results to return. Defaults to 1.
page_size Integer Optional The size of the page to use for pagination of results. Defaults to 100, and can be anywhere from 1-1000.
started ISO-8601 Datetime Optional The start of the time range to query. Supports the ISO-8601 date/time format, (ex: 2015-01-01T00:00:00Z). Supports the ISO-8601 duration format, (ex: PT3H0M0S).
ended ISO-8601 Datetime Optional End of the time range to query, defaults to the current time. Supports the ISO-8601 date/time format, (ex: 2015-01-01T00:00:00Z). Supports the ISO-8601 duration format, (ex: PT3H0M0S).
order String Optional One or more fields to use when ordering the results. Include multiple times to multi-sort, (ex: order=name&order=version). Prefix the field with a dash ‘-‘ to reverse the order, (ex: order=-name).
Successful Response
Status 200 OK
Content Type application/json
JSON Fields
count Integer The total number of results that match the query parameters.
next URL A URL to the next page of results.
previous URL A URL to the previous page of results.
results Array List of result JSON objects that match the query parameters.
.id Integer The unique identifier of the model. Can be passed to the details API call. (See Error Details)
.name String The stable name of the error used for queries.
.title String The human readable display name of the error.
.description String A longer description of the error.
.category String The category of the error. Choices: [SYSTEM, ALGORITHM, DATA].
.created ISO-8601 Datetime When the associated database model was initially created.
.last_modified ISO-8601 Datetime When the associated database model was last saved. 
{
    "count": 23,
    "next": null,
    "previous": null,
    "results": [
        {
            "id": 1,
            "name": "unknown",
            "title": "Unknown",
            "description": "The error that caused the failure is unknown.",
            "category": "SYSTEM",
            "created": "2015-03-11T00:00:00Z",
            "last_modified": "2015-03-11T00:00:00Z"
        },
        ...
    ]
}
Create Error
Creates a new error
POST /errors/
Content Type application/json
JSON Fields
name String The stable name of the error used for queries.
title String The human readable display name of the error.
description String A longer description of the error.
category String The category of the error. Choices: [ALGORITHM, DATA]. 
{
    "name": "error1",
    "title": "Error 1",
    "description": "This is an algorithm error",
    "category": "ALGORITHM"
}
Successful Response
Status 201 CREATED
Location URL pointing to the details for the newly created error
Content Type application/json
JSON Fields
  JSON Object All fields are the same as the error details model. (See Error Details) 
{
    "id": 100,
    "name": "error1",
    "title": "Error 1",
    "description": "This is an algorithm error",
    "category": "ALGORITHM",
    "created": "2015-03-11T00:00:00Z",
    "last_modified": "2015-03-11T00:00:00Z"
}
Error Details
Returns the details for an error with the given id.
GET /errors/{id}/
Where {id} is the unique identifier of an existing model.
Successful Response
Status 200 OK
Content Type application/json
JSON Fields
id Integer The unique identifier of the model.
name String The stable name of the error used for queries.
title String The human readable display name of the error.
description String A longer description of the error.
category String The category of the error. Choices: [SYSTEM, ALGORITHM, DATA].
created ISO-8601 Datetime When the associated database model was initially created.
last_modified ISO-8601 Datetime When the associated database model was last saved. 
{
    "id": 1,
    "name": "unknown",
    "title": "Unknown",
    "description": "The error that caused the failure is unknown.",
    "category": "SYSTEM",
    "created": "2015-03-11T00:00:00Z",
    "last_modified": "2015-03-11T00:00:00Z"
}
Edit Error
Edits an existing error
PATCH /errors/{id}/
Where {id} is the unique identifier of an existing model.
Content Type application/json
JSON Fields
title String Optional The human readable display name of the error.
description String Optional A longer description of the error.
category String Optional The category of the error. Choices: [SYSTEM, ALGORITHM, DATA]. 
{
    "title": "My Error",
    "description": "An edited error description.",
    "category": "ALGORITHM"
}
Successful Response
Status 200 OK
Content Type application/json
JSON Fields
  JSON Object All fields are the same as the error details model. (See Error Details) 
{
    "id": 100,
    "name": "my-error",
    "title": "My Error",
    "description": "An edited error description.",
    "category": "ALGORITHM",
    "created": "2015-03-11T00:00:00Z",
    "last_modified": "2015-03-11T00:00:00Z"
}