Issues¶
Issues are an important topic or problem for debate or discussion. In the SisComando the issues are mainly as ticket of high severity.
List issues¶
List all issues. Remember any requests that returns more than 25 items will be paginated.
GET /issues
...outcome:
{
"_items": [{
"body": "Problema na conex\u00e3o de... ",
"ugat": "COTEC",
"title": "CENTRO DE DADOS (SUPCD)",
"register_orig": "2015RI/16601",
"created_at": "Fri, 24 Jul 2015 18:07:00 GMT",
"register": "2015RI16601",
"updated_at": "Fri, 24 Jul 2015 18:07:00 GMT",
"deadline": 120,
"closed": false,
"_links": {
"self": {
"href": "issues/55b2a8f4f2c3829ea0263ba7",
"title": "Issue"
}
},
"ugser": "SUNAF",
"_id": "55b2a8f4f2c3829ea0263ba7",
"classifier": 0
}, {
"body": "Problema na conex\u00e3o de... ",
"ugat": "SUPOP",
"title": "SIORG (SUNMP)",
"register_orig": "2015RI/78642",
"created_at": "Fri, 24 Jul 2015 18:07:00 GMT",
"register": "2015RI78642",
"updated_at": "Fri, 24 Jul 2015 18:07:00 GMT",
"deadline": 120,
"closed": false,
"_links": {
"self": {
"href": "issues/55b2a8f4f2c3829ea0263bbb",
"title": "Issue"
}
},
"ugser": "SUPDE",
"_id": "55b2a8f4f2c3829ea0263bbb",
"classifier": 0
}],
"_links": {
"self": {
"href": "issues?max_results=2",
"title": "issues"
},
"last": {
"href": "issues?max_results=2&page=52",
"title": "last page"
},
"parent": {
"href": "/",
"title": "home"
},
"next": {
"href": "issues?max_results=2&page=2",
"title": "next page"
}
},
"_meta": {
"max_results": 2,
"total": 103,
"page": 1
}
}
List issues group by title¶
Returns all issues grouped by title where title is a system (e.g: SISCOMEX). The payload returned is a list with dictionaries containing title and issues (e.g {‘title’:’SISCOMEX’, ‘issues’: [{}, {}...]})
GET /issues?grouped=1
curl -X GET -H "Authorization: Basic Wlhs...zY6" -H "Content-Type: application/json"
http://api.siscomando/api/v2/issues?grouped=1
{
// payload omitted...
"_grouped": [{
"issues": [{
"body": "Problema na conexão de... ",
"ugat": "COTEC",
"author": "55b2a8f3f2c3829ea0263b76",
"title": "CENTRO DE DADOS (SUPCD)",
"register_orig": "2015RI/16601",
"created_at": "2015-07-24 18:07:00.769000",
"register": "2015RI16601",
"updated_at": "2015-07-24 18:07:00.770000",
"classifier": 0,
"deadline": 120,
"_cls": "Issue",
"closed": false,
"ugser": "SUNAF",
"_id": "55b2a8f4f2c3829ea0263ba7",
"slug": "centro de dados (supcd)-2015RI16601"
}, {
"body": "Problema na conexão de... ",
"ugat": "SUPOP",
"author": "55b2a8f3f2c3829ea0263b76",
"title": "CENTRO DE DADOS (SUPCD)",
"register_orig": "2015RI/35378",
"created_at": "2015-07-24 18:07:01.710000",
"register": "2015RI35378",
"updated_at": "2015-07-24 18:07:01.711000",
"classifier": 0,
"deadline": 120,
"_cls": "Issue",
"closed": false,
"ugser": "SUPOP",
"_id": "55b2a8f5f2c3829ea0263c33",
"slug": "centro de dados (supcd)-2015RI35378"
}
}],
"title": "CENTRO DE DADOS (SUPCD)"
}]
}
Get an issue¶
GET /issues/<issue_id>
or
GET /issues/<register>
{
"body": "Problema na conex\u00e3o de... ",
"ugat": "SUPOP",
"title": "SIORG (SUNMP)",
"register_orig": "2015RI/78642",
"created_at": "Fri, 24 Jul 2015 18:07:00 GMT",
"register": "2015RI78642",
"updated_at": "Fri, 24 Jul 2015 18:07:00 GMT",
"deadline": 120,
"closed": false,
"_links": {
"self": {
"href": "issues/55b2a8f4f2c3829ea0263bbb",
"title": "Issue"
},
"collection": {
"href": "issues",
"title": "issues"
},
"parent": {
"href": "/",
"title": "home"
}
},
"ugser": "SUPDE",
"_id": "55b2a8f4f2c3829ea0263bbb",
"classifier": 0
}
Get more issues (pagination)¶
There are two ways to get more issues. First to pass page query parameter
in the URL.
GET /issues?page=2
The more programmatic way is handling returned response by HATEOAS. Each query done in the resource that return multiples items will have Pagination info included in the _links. You must use it to constructing your URL.
import requests
import json
r = requests.get('https://api.siscomando/api/v2/issues', auth=('user', 'pass'))
data = json.loads(r.text) # convert json output in the python dictionary
following_link = data['_links']['next']['href'] # catch the link
print "Relative path to get more issues: ", following_link
List comments from issue¶
GET /issues/<issue_id>/comments
TODO: In the moment this can be obtained accessing /comments?where={"issue_id: 51f63e0838345b6dcd7eabff"}
Create an issue¶
This is a task to superusers role. Therefore there is slightly difference in the URL (the s was suppressed).
POST /issues/
Parameters¶
* Required
| Name | Type | Description |
|---|---|---|
| title* | string | Title of the issue. |
| body* | string | Details of the demand. |
| register* | string | ID of the issue. |
| classifier | integer | Impact in the business (high, highest) |
| ugat* | string | Abbrev. for unit or sector for treatment |
| ugser* | string | Abbrev. for unit or sector responsible |
| deadline | integer | Time for treatment (default: 120) |
| closed | boolean | If closed or not (default: False) |
Example Request¶
$ curl -H "Content-Type: application/json" -u 'super@superuser.com:pass' \
-x POST https://api.siscomando/api/v2/issues/new \
-d "title=SISCOMEX API"
-d "body=Siscomex fora do ar"
-d "register=2015RI/000012831"
-d "ugat=SUPOP"
-d "ugser=SUPGS"
... return:
{
"created_at": "Thu, 30 Jul 2015 19:11:01 GMT",
"_status": "OK",
"_links": {
"self":{
"href": "issue/55ba76c5f2c3820b29360935",
"title": "SISCOMEX API"
}
},
"updated_at": "Thu, 30 Jul 2015 19:11:01 GMT",
"_id": "55ba76c5f2c3820b29360935"
}
Create bulk issues¶
In order to reduce the number of loopbacks, a client might also submit multiple documents with a single request. All it needs to do is enclose the documents in a JSON list.
POST /issues/
Example Request¶
$ curl -H "Content-Type: application/json" -u 'super@superuser.com:pass' \
-X POST https://api.siscomando/api/v2/issues/new -d '[{document1}, {document2}]'
When multiple documents are submitted the API takes advantage of MongoDB bulk insert capabilities which means that not only there’s just one single request traveling from the client to the remote API, but also that only one loopback is performed between the API server and the database. See more Bulk Write Operations.