v6 Timeline Services

These services provide access to information about the timeline functionality.

v6 Recipe Types

Example GET /v6/timeline/recipe-types API call

Request: GET http://.../v6/timeline/recipe-types/

Response: 200 OK

{
    "count": 1,
    "results": [
        {
            "recipe_type_id": 1,
            "name": "recipe-type-name",
            "title": "Recipe Type Title",
            "revision_num": 1,
            "results": [{
                "date": "2015-03-11T00:00:00Z",
                "count": 457
            }]
        }
    ]
}

Timeline Recipe Types List
Returns a list of recipe types that were started between the given dates
GET /v6/timeline/recipe-types/
Query Parameters
started	ISO-8601 Datetime	Required	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).
id	Integer	Optional	Return timeline information matching only the given id(s). Duplicate for multiple.
name	String	Optional	Return timeline information matching only the given name(s). Duplicate for multiple.
rev	Integer	Optional	Return timeline information matching only the given revision(s). Duplicate for multiple.
Successful Response
Status	200 OK
Content Type	application/json
JSON Fields
count	Integer	The total number of results that match the query parameters.
results	Array	List of result JSON objects that match the query parameters.
.recipe_type_id	Integer	The unique identifier of the recipe type.
.name	String	The name (key) of the recipe type.
.title	String	The title of the recipe type.
.revision_num	Integer	The revision number of the recipe type.
.results	Array	Lists the dates and counts of recipe types.
.date	ISO-8601 Datetime	The date of the count.
.count	Integer	Number of recipe types that were started on that date.

v6 Job Types

Example GET /v6/timeline/job-types API call

Request: GET http://.../v6/timeline/job-types/

Response: 200 OK

{
    "count": 1,
    "results": [
        {
            "job_type_id": 1,
            "name": "job-type-name",
            "version": "1.0.0",
            "title": "Job Type Title",
            "revision_num": 1,
            "results": [{
                "date": "2015-03-11T00:00:00Z",
                "count": 338
            }]
        }
    ]
}

Timeline Job Types List
Returns a list of job types that were started between the given dates
GET /v6/timeline/job-types/
Query Parameters
started	ISO-8601 Datetime	Required	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).
id	Integer	Optional	Return timeline information matching only the given id(s). Duplicate for multiple.
name	String	Optional	Return timeline information matching only the given name(s). Duplicate for multiple.
version	String	Optional	Return timeline information matching only the given version(s). Duplicate for multiple.
Successful Response
Status	200 OK
Content Type	application/json
JSON Fields
count	Integer	The total number of results that match the query parameters.
results	Array	List of result JSON objects that match the query parameters.
.job_type_id	Integer	The unique identifier of the job type.
.name	String	The name (key) of the job type.
.version	String	The job type version.
.title	String	The title of the job type.
.revision_num	Integer	The revision number of the job type.
.results	Array	Lists the dates and counts of job types.
.date	ISO-8601 Datetime	The date of the count.
.count	Integer	Number of job types that were started on that date.