Get Application Assignments

Get Application Assignments

Get Application Assignments

Request
URI
GET
https://{api_host}/app_volumes/app_assignments
COPY
Query Parameters
integer
page[number]
Required

The Page number for which assignments are required

integer
page[size]
Required

The size of Page (i.e. The number of records we want on one page)

integer
api_version
Required

The api_version supported for api

string
include
Optional

The models available to fetch relationships of app assignments

Possible values are : app_assignment_entities, assignment_filters, app_marker, app_package, app_product,

Responses
200

List of Application Assignments.

Returns GetAppAssignmentPagination of type(s) application/json
{
    "data": [
        {
            "id": 1,
            "type": "app_assignments",
            "links": {
                "self": "http://localhost:3000/app_volumes/app_assignments/1"
            },
            "attributes": {
                "app_marker_id": 0,
                "app_product_id": 0,
                "app_package_id": 0,
                "created_at": "2021-12-03 13:10:13 -0800",
                "created_at_human": "Dec 03 2021",
                "updated_at": "2021-12-03 13:10:13 -0800",
                "updated_at_human": "Dec 03 2021",
                "delivery": "default"
            },
            "relationships": {
                "app_product": {
                    "data": {
                        "type": "app_products",
                        "id": 1
                    }
                },
                "app_marker": {
                    "data": {
                        "type": "app_markers",
                        "id": 1
                    }
                },
                "app_package": {
                    "data": {
                        "type": "app_packages",
                        "id": 1
                    }
                },
                "app_assignment_entities": {
                    "data": [
                        {
                            "type": "app_assignment_entities",
                            "id": 1
                        }
                    ]
                },
                "assignment_filters": {
                    "data": [
                        {
                            "type": "assignment_filters",
                            "id": 1
                        }
                    ]
                }
            }
        }
    ],
    "included": [
        {
            "id": 1,
            "type": "app_packages",
            "attributes": {
                "name": "Notepad++ 7.2.0",
                "guid": "b9421adb-d6cb-47f0-81ba-10718d3a8611",
                "app_product_id": 1,
                "state": "Package",
                "version": "7.2.0",
                "programs_count": 1,
                "operating_systems_count": 1,
                "description": "string"
            }
        }
    ],
    "meta": {
        "total": 18,
        "filtered": 18,
        "page_count": 6
    },
    "links": {
        "first": "http://localhost:3000/app_volumes/app_assignments?include=app_assignment_entities%2Cassignment_filters%2Capp_marker%2Capp_package%2Capp_marker.app_package%2Capp_product%2Capp_assignment_entities.target&page%5Bnumber%5D=1&page%5Bsize%5D=3",
        "next": "http://localhost:3000/app_volumes/app_assignments?include=app_assignment_entities%2Cassignment_filters%2Capp_marker%2Capp_package%2Capp_marker.app_package%2Capp_product%2Capp_assignment_entities.target&page%5Bnumber%5D=2&page%5Bsize%5D=3",
        "last": "http://localhost:3000/app_volumes/app_assignments?include=app_assignment_entities%2Cassignment_filters%2Capp_marker%2Capp_package%2Capp_marker.app_package%2Capp_product%2Capp_assignment_entities.target&page%5Bnumber%5D=6&page%5Bsize%5D=3"
    }
}
data
Optional

data

included
Optional

included

meta
Optional

meta

links
Optional

links


400

Bad Request

Returns GetAppAssignmentBadRequest of type(s) application/json
{
    "errors": [
        {
            "title": "Invalid page value",
            "detail": "0 is not a valid value for number page parameter.",
            "code": 118,
            "status": 400
        }
    ]
}
array of object
errors
Optional

errors


403

Session expired. Create a session and make the request with the _session_id cookie.

Returns UnauthorizedError of type(s) application/json
{
    "error": "Session expired. Please login again."
}
string
error
Optional

Session expired. Create a session using and make the request with the _session_id cookie.


500

Server error.

Returns ServerError of type(s) application/json
{
    "error": "Server Error",
    "detail": "Unexpected server error."
}
string
error
Optional

Server Error.

string
detail
Optional

Details of error. Exact error format subject to change depending on type of error.