Update documentation for job_plays and job_tasks endpoints

This commit is contained in:
Matthew Jones
2014-07-16 15:15:29 -04:00
parent a7a092f30a
commit 985cba94ef
3 changed files with 54 additions and 2 deletions

View File

@@ -0,0 +1,25 @@
Make a GET request to retrieve the list of aggregated play data associated with a job
## Filtering
This endpoints supports a limited filtering subset:
?id__in=1,2,3
Will show only the given ids.
?id__gt=1
Will show ids greater than the given one.
?id__lt=3
Will show ids less than the given one.
?failed=true
Will show only failed plays. Alternatively `false` may be used.
?play_icontains=test
Will filter plays matching the substring `test`

View File

@@ -0,0 +1,27 @@
Make a GET request to retrieve the list of aggregated task data associated with the play given by event_id.
`event_id` is a required query parameter and must match the job event id of the parent play in order to receive the list of tasks associated with the play
## Filtering
This endpoints supports a limited filtering subset:
?id__in=1,2,3
Will show only the given ids.
?id__gt=1
Will show ids greater than the given one.
?id__lt=3
Will show ids less than the given one.
?failed=true
Will show only failed plays. Alternatively `false` may be used.
?task_icontains=test
Will filter tasks matching the substring `test`