EventGroupResource
Event group resource
The following resources are applicable:
/eventGroups
Mount Point: /../../../api/v1/eventGroups
GET
Returns an event group list according to search parameters.
STATUS CODES :
200 - OK
Parameters
name | description | type | default |
---|---|---|---|
modifiedSince | timestamp in millisecond after which a modification occured | query | |
count | the maximum number of event groups to be returned | query | |
startIndex | the start index of the list | query | |
title | event group title criteria | query |
Response Body
element: | eventGroupListResponse |
media types: | application/xml application/json |
an event group list according to search parameters
POST
Create an event group
STATUS CODES :
200 - The event group was created
400 - There was errors processing the request, the body will contain a message
Request Body
element: | eventGroup |
media types: | application/xml application/json |
event group data
Response Body
element: | eventGroupResponse |
media types: | application/xml application/json |
the created event group or a message if the status is not 200
/eventGroups/{eventGroupId}
Mount Point: /../../../api/v1/eventGroups/{eventGroupId}
GET
Gets detailed event group by sowprog id
STATUS CODES :
200 - The event group is returned
404 - The id does not exist
Parameters
name | description | type | default |
---|---|---|---|
eventGroupId | sowprog event group id | path |
Response Body
element: | eventGroupResponse |
media types: | application/xml application/json |
the detailed event group
PUT
Update an event group.
Only fields that are provided are updated. If a field with an empty value is provided, checks are enforced.
Example : if title is not provided, it will not be updated. If it is provided as an empty value, you will get an error message saying it is mandatory.
STATUS CODES :
200 - The event group was updated
404 - The id does not exist
400 - There was errors processing the request, the body will contain a message
Parameters
name | description | type | default |
---|---|---|---|
eventGroupId | sowprog event group id | path |
Request Body
element: | eventGroup |
media types: | application/xml application/json |
event group data
Response Body
element: | eventGroupResponse |
media types: | application/xml application/json |
the created event group or a message if the status is not 200
/eventGroups/{eventGroupId}/picture
Mount Point: /../../../api/v1/eventGroups/{eventGroupId}/picture
PUT
Defines event group associated image.
The form must be encoded as a multipart/form-data and the data parameter key must be "file"
STATUS CODES :
200 - The event group is returned
404 - The id does not exist
400 - error processing the file, the body will contain a message
Parameters
name | description | type | default |
---|---|---|---|
eventGroupId | sowprog event group id | path | |
fileInputStream | (no documentation provided) | formdata | |
contentDispositionHeader | (no documentation provided) | formdata |
Response Body
element: | eventGroupResponse |
media types: | application/xml application/json |
the updated event group