Group List

Method: GET

URL: /rest_api/v1/component-groups/{instance_pk}/

Response:

{
    "components (optional, default=null)": [
        {
            "id": "int", 
            "name": "string"
        }
    ], 
    "description": "string", 
    "group_type": "GroupType.name", 
    "id (read-only)": "int", 
    "release": "Release.release_id"
}

Method: POST

URL: /rest_api/v1/component-groups/

Data:

{
    "group_type":       string,         # required
    "release":          string,         # required
    "description":      string,         # required
    "components":       list            # optional
}

group_type: /rest_api/v1/component-group-types/

Note:

• components: list of release_components, eg: [{"id": 1}, {"id": 2}] or [{"release": "release-1.0", "name": "python27"}]
• group_type, release and release_components have to be existed before creating Release Component Group
• It's not allowed to group release_components from different releases

Response:

{
    "components (optional, default=null)": [
        {
            "id": "int", 
            "name": "string"
        }
    ], 
    "description": "string", 
    "group_type": "GroupType.name", 
    "id (read-only)": "int", 
    "release": "Release.release_id"
}

It is possible to create this resource in bulk. To do so, use the same procedure as when creating a single instance, only the request body should contain a list of JSON objects. The response you get back will also contain a list of values which you would obtain by submitting the request data separately.

Method: PUT, PATCH

URL: /rest_api/v1/component-groups/{instance_pk}/

Data:

{
    "group_type":       string,
    "release":          string,
    "description":      string,
    "components":       list
}

Note:

• components: list of release_components, eg: [{"id": 1}, {"id": 2}] or [{"release": "release-1.0", "name": "python27"}]

Response:

{
    "components (optional, default=null)": [
        {
            "id": "int", 
            "name": "string"
        }
    ], 
    "description": "string", 
    "group_type": "GroupType.name", 
    "id (read-only)": "int", 
    "release": "Release.release_id"
}

Method: DELETE

URL: /rest_api/v1/component-groups/{instance_pk}/

Response:

On success, HTTP status code is 204 and the response has no content.

It is possible to delete multiple items in one request. Use the DELETE method with the same url as for listing/creating objects. The request body should contain a list with identifiers for objects to be deleted. The identifier is usually the last part of the URL for deleting a single object.

It is possible to update multiple objects in one request. Use the PUT or PATCH method with the same url as for listing/creating objects. The request body should contain an object, where keys are identifiers of objects to be modified and their values use the same format as normal update.