Incidents¶
(implementation of Incident entity)
Provides following method for API calls:
Create¶
URL:¶
/api/v1/{format}/incidents
Method:¶
POST
Parameters response:¶
Object
Description:
- title(STRING)
- description(STRING)
- reported_date(NUMBER(Date representation wrapped))
- categories(ARRAY< Category >)
- pupils(ARRAY< Pupil >)
- status(OBJECT< Status >)
- priority(OBJECT< Priority >)
- issue(OBJECT< Issue >)
- assigned_date(NUMBER(Date representation wrapped))
- assigned_by(OBJECT< Person >)
- archived_date(NUMBER(Date representation wrapped))
- archived_by(OBJECT< Person >)
- reported_by(OBJECT< Person >)
- modified_by(OBJECT< Person >)
- modified_date(NUMBER(Date representation wrapped))
- id(NUMBER)
Delete¶
URL:¶
/api/v1/{format}/incidents/{id}
Method:¶
DELETE
Parameters request:¶
null
Parameters response:¶
Object
Description:
- title(STRING)
- description(STRING)
- reported_date(NUMBER(Date representation wrapped))
- categories(ARRAY< Category >)
- pupils(ARRAY< Pupil >)
- status(OBJECT< Status >)
- priority(OBJECT< Priority >)
- issue(OBJECT< Issue >)
- assigned_date(NUMBER(Date representation wrapped))
- assigned_by(OBJECT< Person >)
- archived_date(NUMBER(Date representation wrapped))
- archived_by(OBJECT< Person >)
- reported_by(OBJECT< Person >)
- modified_by(OBJECT< Person >)
- modified_date(NUMBER(Date representation wrapped))
- id(NUMBER)
DeleteByIds¶
URL:¶
/api/v1/{format}/incidents
Method:¶
DELETE
Parameters request:¶
Url parameters: ids
Parameters response:¶
Array
Description:
- title(STRING)
- description(STRING)
- reported_date(NUMBER(Date representation wrapped))
- categories(ARRAY< Category >)
- pupils(ARRAY< Pupil >)
- status(OBJECT< Status >)
- priority(OBJECT< Priority >)
- issue(OBJECT< Issue >)
- assigned_date(NUMBER(Date representation wrapped))
- assigned_by(OBJECT< Person >)
- archived_date(NUMBER(Date representation wrapped))
- archived_by(OBJECT< Person >)
- reported_by(OBJECT< Person >)
- modified_by(OBJECT< Person >)
- modified_date(NUMBER(Date representation wrapped))
- id(NUMBER)
FindByCriteria¶
URL:¶
/api/v1/{format}/incidents
Method:¶
GET
Parameters request:¶
Url parameters: search_text, order_by
Parameters response:¶
Array
Description:
- title(STRING)
- description(STRING)
- reported_date(NUMBER(Date representation wrapped))
- categories(ARRAY< Category >)
- pupils(ARRAY< Pupil >)
- status(OBJECT< Status >)
- priority(OBJECT< Priority >)
- issue(OBJECT< Issue >)
- assigned_date(NUMBER(Date representation wrapped))
- assigned_by(OBJECT< Person >)
- archived_date(NUMBER(Date representation wrapped))
- archived_by(OBJECT< Person >)
- reported_by(OBJECT< Person >)
- modified_by(OBJECT< Person >)
- modified_date(NUMBER(Date representation wrapped))
- id(NUMBER)
Get¶
URL:¶
/api/v1/{format}/incidents/{id}
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Object
Description:
- title(STRING)
- description(STRING)
- reported_date(NUMBER(Date representation wrapped))
- categories(ARRAY< Category >)
- pupils(ARRAY< Pupil >)
- status(OBJECT< Status >)
- priority(OBJECT< Priority >)
- issue(OBJECT< Issue >)
- assigned_date(NUMBER(Date representation wrapped))
- assigned_by(OBJECT< Person >)
- archived_date(NUMBER(Date representation wrapped))
- archived_by(OBJECT< Person >)
- reported_by(OBJECT< Person >)
- modified_by(OBJECT< Person >)
- modified_date(NUMBER(Date representation wrapped))
- id(NUMBER)
GetAll¶
URL:¶
/api/v1/{format}/incidents
Method:¶
GET
Parameters request:¶
null
Parameters response:¶
Array
Description:
- title(STRING)
- description(STRING)
- reported_date(NUMBER(Date representation wrapped))
- categories(ARRAY< Category >)
- pupils(ARRAY< Pupil >)
- status(OBJECT< Status >)
- priority(OBJECT< Priority >)
- issue(OBJECT< Issue >)
- assigned_date(NUMBER(Date representation wrapped))
- assigned_by(OBJECT< Person >)
- archived_date(NUMBER(Date representation wrapped))
- archived_by(OBJECT< Person >)
- reported_by(OBJECT< Person >)
- modified_by(OBJECT< Person >)
- modified_date(NUMBER(Date representation wrapped))
- id(NUMBER)
SaveAll¶
URL:¶
/api/v1/{format}/incidents/saveall
Method:¶
POST
Parameters response:¶
Array
Description:
- title(STRING)
- description(STRING)
- reported_date(NUMBER(Date representation wrapped))
- categories(ARRAY< Category >)
- pupils(ARRAY< Pupil >)
- status(OBJECT< Status >)
- priority(OBJECT< Priority >)
- issue(OBJECT< Issue >)
- assigned_date(NUMBER(Date representation wrapped))
- assigned_by(OBJECT< Person >)
- archived_date(NUMBER(Date representation wrapped))
- archived_by(OBJECT< Person >)
- reported_by(OBJECT< Person >)
- modified_by(OBJECT< Person >)
- modified_date(NUMBER(Date representation wrapped))
- id(NUMBER)
SaveAllAndReturnIds¶
URL:¶
/api/v1/{format}/incidents/saveall
Method:¶
POST
Parameters response:¶
Array
- Description:
- ARRAY<NUMBER>
Search¶
URL:¶
/api/v1/{format}/incidents/search
Method:¶
POST
Parameters request:¶
Array< SearchCriteries$SearchCriteriaResult >
Parameters response:¶
Array
Description:
- title(STRING)
- description(STRING)
- reported_date(NUMBER(Date representation wrapped))
- categories(ARRAY< Category >)
- pupils(ARRAY< Pupil >)
- status(OBJECT< Status >)
- priority(OBJECT< Priority >)
- issue(OBJECT< Issue >)
- assigned_date(NUMBER(Date representation wrapped))
- assigned_by(OBJECT< Person >)
- archived_date(NUMBER(Date representation wrapped))
- archived_by(OBJECT< Person >)
- reported_by(OBJECT< Person >)
- modified_by(OBJECT< Person >)
- modified_date(NUMBER(Date representation wrapped))
- id(NUMBER)
SearchFirst¶
URL:¶
/api/v1/{format}/incidents/search/first
Method:¶
POST
Parameters request:¶
Array< SearchCriteries$SearchCriteriaResult >
Parameters response:¶
Object
Description:
- title(STRING)
- description(STRING)
- reported_date(NUMBER(Date representation wrapped))
- categories(ARRAY< Category >)
- pupils(ARRAY< Pupil >)
- status(OBJECT< Status >)
- priority(OBJECT< Priority >)
- issue(OBJECT< Issue >)
- assigned_date(NUMBER(Date representation wrapped))
- assigned_by(OBJECT< Person >)
- archived_date(NUMBER(Date representation wrapped))
- archived_by(OBJECT< Person >)
- reported_by(OBJECT< Person >)
- modified_by(OBJECT< Person >)
- modified_date(NUMBER(Date representation wrapped))
- id(NUMBER)
Update¶
URL:¶
/api/v1/{format}/incidents/{id}
Method:¶
PUT
Parameters response:¶
Object
Description:
- title(STRING)
- description(STRING)
- reported_date(NUMBER(Date representation wrapped))
- categories(ARRAY< Category >)
- pupils(ARRAY< Pupil >)
- status(OBJECT< Status >)
- priority(OBJECT< Priority >)
- issue(OBJECT< Issue >)
- assigned_date(NUMBER(Date representation wrapped))
- assigned_by(OBJECT< Person >)
- archived_date(NUMBER(Date representation wrapped))
- archived_by(OBJECT< Person >)
- reported_by(OBJECT< Person >)
- modified_by(OBJECT< Person >)
- modified_date(NUMBER(Date representation wrapped))
- id(NUMBER)