Purchasing Service
No description provided (generated by Swagger Codegen https://github.com/swagger-api/swagger-codegen)
More information: https://helloreverb.com
Contact Info: [email protected]
Version: v1
BasePath:/
All rights reserved
http://apache.org/licenses/LICENSE-2.0.html
Access
Methods
ModelsTable of Contents
Assignments
get /api/v1/assignments/{id}get /api/v1/assignmentsget /api/v1/assignments/of/computers/{id}get /api/v1/assignments/to/computers/{id}get /api/v1/assignments/to/groups/computers/{id}get /api/v1/assignments/to/users/{id}get /api/v1/assignments/to/groups/users/{id}get /api/v1/assignments/to/groups/computersget /api/v1/assignments/to/computersget /api/v1/assignments/to/groups/usersget /api/v1/assignments/to/usersget /api/v1/assignments/of/computersget /api/v1/assignments/of/softwareget /api/v1/assignments/of/software/licenseunits/{id}get /api/v1/assignments/of/software/licenseunits
ComputerGroups
get /api/v1/groups/computers/{id}get /api/v1/groups/computersget /api/v1/hardware/computers/{id}/groups
LineItems
get /api/v1/purchases/lineitems/hardwareget /api/v1/purchases/lineitems/hardware/{type}get /api/v1/purchases/lineitems/{id}get /api/v1/purchases/lineitemsget /api/v1/purchases/orders/{id}/lineitemsget /api/v1/purchases/lineitems/maintenanceget /api/v1/purchases/lineitems/maintenance/{type}get /api/v1/purchases/lineitems/software
Orders
UserGroups
Users
Assignments
Up
get /api/v1/assignments/{id}Get one assignment by its identifier (assignmentsGetAssignmentById)
Path parameters
id (required)
Path Parameter — Assignment Id
Query parameters
fields (optional)
Query Parameter — The column names of the fields to return
Return type
Example data
Content-Type: application/json
{
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success AssignmentDto400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/assignmentsGet a list of assignments (assignmentsGetAssignments)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[AssignmentDto]
Example data
Content-Type: application/json
[ {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
}, {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
List of Assignments400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/assignments/of/computers/{id}Get assignments of a computer (assignmentsGetAssignmentsForAComputer)
Path parameters
id (required)
Path Parameter — Computer Id
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[AssignmentDto]
Example data
Content-Type: application/json
[ {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
}, {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/assignments/to/computers/{id}Get a list of assignments to a computer (assignmentsGetAssignmentsToAComputer)
Path parameters
id (required)
Path Parameter — Computers Id
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[AssignmentDto]
Example data
Content-Type: application/json
[ {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
}, {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/assignments/to/groups/computers/{id}Get a list of assignments to a computer group (assignmentsGetAssignmentsToAComputerGroup)
Path parameters
id (required)
Path Parameter — Computer Group Id
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[AssignmentDto]
Example data
Content-Type: application/json
[ {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
}, {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/assignments/to/users/{id}Get a list of assignments to a user (assignmentsGetAssignmentsToAUser)
Path parameters
id (required)
Path Parameter — User Id
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[AssignmentDto]
Example data
Content-Type: application/json
[ {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
}, {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/assignments/to/groups/users/{id}Get a list of assignments to a user group (assignmentsGetAssignmentsToAUserGroup)
Path parameters
id (required)
Path Parameter — User Group Id
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[AssignmentDto]
Example data
Content-Type: application/json
[ {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
}, {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/assignments/to/groups/computersGet a list of assignments to computers groups (assignmentsGetAssignmentsToComputerGroups)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[AssignmentDto]
Example data
Content-Type: application/json
[ {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
}, {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/assignments/to/computersGet a list of assignments to computers (assignmentsGetAssignmentsToComputers)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[AssignmentDto]
Example data
Content-Type: application/json
[ {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
}, {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/assignments/to/groups/usersGet a list of assignments to users groups (assignmentsGetAssignmentsToUserGroups)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[AssignmentDto]
Example data
Content-Type: application/json
[ {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
}, {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/assignments/to/usersGet a list of assignments to users (assignmentsGetAssignmentsToUsers)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[AssignmentDto]
Example data
Content-Type: application/json
[ {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
}, {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/assignments/of/computersGet a list of computer assignments (assignmentsGetComputerAssignments)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[AssignmentDto]
Example data
Content-Type: application/json
[ {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
}, {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/assignments/of/softwareGet a list of software assignments (assignmentsGetSoftwareAssignments)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[AssignmentDto]
Example data
Content-Type: application/json
[ {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
}, {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/assignments/of/software/licenseunits/{id}Get assignments for a license unit (assignmentsGetSoftwareAssignmentsForALicenseUnit)
Path parameters
id (required)
Path Parameter — License Unit Id
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[AssignmentDto]
Example data
Content-Type: application/json
[ {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
}, {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/assignments/of/software/licenseunitsGet a list of software assignments for license units (assignmentsGetSoftwareAssignmentsForLicenseUnits)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[AssignmentDto]
Example data
Content-Type: application/json
[ {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
}, {
"itemType" : "itemType",
"quantity" : 6,
"serialNumber" : "serialNumber",
"assignedToGroupName" : "assignedToGroupName",
"assignedToGroupType" : "assignedToGroupType",
"assignedToName" : "assignedToName",
"assignedToType" : "assignedToType",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"assignmentId" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorComputerGroups
Up
get /api/v1/groups/computers/{id}Get one computer group by its identifier (computerGroupsGetComputerGroupById)
Path parameters
id (required)
Path Parameter — Computer Group Id
Query parameters
fields (optional)
Query Parameter — The column names of the fields to return
Return type
Example data
Content-Type: application/json
{
"computerGroupId" : 0,
"path" : "path",
"name" : "name",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success ComputerGroupDto400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/groups/computersGet a list of computer groups (computerGroupsGetComputerGroups)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[ComputerGroupDto]
Example data
Content-Type: application/json
[ {
"computerGroupId" : 0,
"path" : "path",
"name" : "name",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ]
}, {
"computerGroupId" : 0,
"path" : "path",
"name" : "name",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ]
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/hardware/computers/{id}/groupsGet a list of computer groups for which a computer is associated (computerGroupsGetComputerGroupsByComputerId)
Path parameters
id (required)
Path Parameter — Computer Id
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[ComputerGroupDto]
Example data
Content-Type: application/json
[ {
"computerGroupId" : 0,
"path" : "path",
"name" : "name",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ]
}, {
"computerGroupId" : 0,
"path" : "path",
"name" : "name",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ]
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorLineItems
Up
get /api/v1/purchases/lineitems/hardwareGet all hardware line items (lineItemsGetHardwareLineItems)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[LineItemDto]
Example data
Content-Type: application/json
[ {
"unitPrice" : 1.4658129805029452,
"notes" : "notes",
"quantity" : 6,
"lineItemId" : 0,
"manufacturerName" : "manufacturerName",
"name" : "name",
"description" : "description",
"contractNumber" : "contractNumber",
"partNumber" : "partNumber",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"type" : "type",
"status" : "status"
}, {
"unitPrice" : 1.4658129805029452,
"notes" : "notes",
"quantity" : 6,
"lineItemId" : 0,
"manufacturerName" : "manufacturerName",
"name" : "name",
"description" : "description",
"contractNumber" : "contractNumber",
"partNumber" : "partNumber",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"type" : "type",
"status" : "status"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/purchases/lineitems/hardware/{type}Get all hardware line items by type (lineItemsGetHardwareLineItemsByType)
Path parameters
type (required)
Path Parameter — The type of hardware item. Examples: "computer", "ipad", etc.
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[LineItemDto]
Example data
Content-Type: application/json
[ {
"unitPrice" : 1.4658129805029452,
"notes" : "notes",
"quantity" : 6,
"lineItemId" : 0,
"manufacturerName" : "manufacturerName",
"name" : "name",
"description" : "description",
"contractNumber" : "contractNumber",
"partNumber" : "partNumber",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"type" : "type",
"status" : "status"
}, {
"unitPrice" : 1.4658129805029452,
"notes" : "notes",
"quantity" : 6,
"lineItemId" : 0,
"manufacturerName" : "manufacturerName",
"name" : "name",
"description" : "description",
"contractNumber" : "contractNumber",
"partNumber" : "partNumber",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"type" : "type",
"status" : "status"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/purchases/lineitems/{id}Get one line item by its identifier (lineItemsGetLineItemById)
Path parameters
id (required)
Path Parameter — Line Item Id
Query parameters
fields (optional)
Query Parameter — The column names of the fields to return
Return type
Example data
Content-Type: application/json
{
"unitPrice" : 1.4658129805029452,
"notes" : "notes",
"quantity" : 6,
"lineItemId" : 0,
"manufacturerName" : "manufacturerName",
"name" : "name",
"description" : "description",
"contractNumber" : "contractNumber",
"partNumber" : "partNumber",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"type" : "type",
"status" : "status"
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success LineItemDto400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/purchases/lineitemsGet all line items (lineItemsGetLineItems)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[LineItemDto]
Example data
Content-Type: application/json
[ {
"unitPrice" : 1.4658129805029452,
"notes" : "notes",
"quantity" : 6,
"lineItemId" : 0,
"manufacturerName" : "manufacturerName",
"name" : "name",
"description" : "description",
"contractNumber" : "contractNumber",
"partNumber" : "partNumber",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"type" : "type",
"status" : "status"
}, {
"unitPrice" : 1.4658129805029452,
"notes" : "notes",
"quantity" : 6,
"lineItemId" : 0,
"manufacturerName" : "manufacturerName",
"name" : "name",
"description" : "description",
"contractNumber" : "contractNumber",
"partNumber" : "partNumber",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"type" : "type",
"status" : "status"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/purchases/orders/{id}/lineitemsGet all line items related to a single order (lineItemsGetLineItemsForOrderById)
Path parameters
id (required)
Path Parameter — Order Id
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[LineItemDto]
Example data
Content-Type: application/json
[ {
"unitPrice" : 1.4658129805029452,
"notes" : "notes",
"quantity" : 6,
"lineItemId" : 0,
"manufacturerName" : "manufacturerName",
"name" : "name",
"description" : "description",
"contractNumber" : "contractNumber",
"partNumber" : "partNumber",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"type" : "type",
"status" : "status"
}, {
"unitPrice" : 1.4658129805029452,
"notes" : "notes",
"quantity" : 6,
"lineItemId" : 0,
"manufacturerName" : "manufacturerName",
"name" : "name",
"description" : "description",
"contractNumber" : "contractNumber",
"partNumber" : "partNumber",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"type" : "type",
"status" : "status"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/purchases/lineitems/maintenanceGet all maintenance line items (lineItemsGetMaintenanceLineItems)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[MaintenanceItemDto]
Example data
Content-Type: application/json
[ {
"unitPrice" : 1.4658129805029452,
"notes" : "notes",
"quantity" : 6,
"endDate" : "2000-01-23T04:56:07.000+00:00",
"lineItemId" : 0,
"manufacturerName" : "manufacturerName",
"description" : "description",
"contractNumber" : "contractNumber",
"type" : "type",
"name" : "name",
"partNumber" : "partNumber",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"startDate" : "2000-01-23T04:56:07.000+00:00",
"status" : "status"
}, {
"unitPrice" : 1.4658129805029452,
"notes" : "notes",
"quantity" : 6,
"endDate" : "2000-01-23T04:56:07.000+00:00",
"lineItemId" : 0,
"manufacturerName" : "manufacturerName",
"description" : "description",
"contractNumber" : "contractNumber",
"type" : "type",
"name" : "name",
"partNumber" : "partNumber",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"startDate" : "2000-01-23T04:56:07.000+00:00",
"status" : "status"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/purchases/lineitems/maintenance/{type}Get maintenance line items of the specified type (hardware, software) (lineItemsGetMaintenanceLineItemsByType)
Path parameters
type (required)
Path Parameter — The type of maintenance item, either "software" or "hardware"
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[MaintenanceItemDto]
Example data
Content-Type: application/json
[ {
"unitPrice" : 1.4658129805029452,
"notes" : "notes",
"quantity" : 6,
"endDate" : "2000-01-23T04:56:07.000+00:00",
"lineItemId" : 0,
"manufacturerName" : "manufacturerName",
"description" : "description",
"contractNumber" : "contractNumber",
"type" : "type",
"name" : "name",
"partNumber" : "partNumber",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"startDate" : "2000-01-23T04:56:07.000+00:00",
"status" : "status"
}, {
"unitPrice" : 1.4658129805029452,
"notes" : "notes",
"quantity" : 6,
"endDate" : "2000-01-23T04:56:07.000+00:00",
"lineItemId" : 0,
"manufacturerName" : "manufacturerName",
"description" : "description",
"contractNumber" : "contractNumber",
"type" : "type",
"name" : "name",
"partNumber" : "partNumber",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"startDate" : "2000-01-23T04:56:07.000+00:00",
"status" : "status"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/purchases/lineitems/softwareGet all software line items (lineItemsGetSoftwareLineItems)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[SoftwareItemDto]
Example data
Content-Type: application/json
[ {
"unitPrice" : 1.4658129805029452,
"notes" : "notes",
"quantity" : 6,
"lineItemId" : 0,
"manufacturerName" : "manufacturerName",
"description" : "description",
"contractNumber" : "contractNumber",
"type" : "type",
"licenseType" : "licenseType",
"isUpgradeLicense" : true,
"name" : "name",
"partNumber" : "partNumber",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"status" : "status"
}, {
"unitPrice" : 1.4658129805029452,
"notes" : "notes",
"quantity" : 6,
"lineItemId" : 0,
"manufacturerName" : "manufacturerName",
"description" : "description",
"contractNumber" : "contractNumber",
"type" : "type",
"licenseType" : "licenseType",
"isUpgradeLicense" : true,
"name" : "name",
"partNumber" : "partNumber",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"status" : "status"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorOrders
Up
get /api/v1/purchases/ordersGet a list of orders (ordersGetAllOrders)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[OrderDto]
Example data
Content-Type: application/json
[ {
"date" : "2000-01-23T04:56:07.000+00:00",
"orderNumber" : "orderNumber",
"orderId" : 0,
"accessProfileName" : "accessProfileName",
"invoiceNumber" : "invoiceNumber",
"description" : "description",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"vendorName" : "vendorName",
"poNumber" : "poNumber"
}, {
"date" : "2000-01-23T04:56:07.000+00:00",
"orderNumber" : "orderNumber",
"orderId" : 0,
"accessProfileName" : "accessProfileName",
"invoiceNumber" : "invoiceNumber",
"description" : "description",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"vendorName" : "vendorName",
"poNumber" : "poNumber"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/purchasesGet a list of orders (ordersGetAllOrders_1)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[OrderDto]
Example data
Content-Type: application/json
[ {
"date" : "2000-01-23T04:56:07.000+00:00",
"orderNumber" : "orderNumber",
"orderId" : 0,
"accessProfileName" : "accessProfileName",
"invoiceNumber" : "invoiceNumber",
"description" : "description",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"vendorName" : "vendorName",
"poNumber" : "poNumber"
}, {
"date" : "2000-01-23T04:56:07.000+00:00",
"orderNumber" : "orderNumber",
"orderId" : 0,
"accessProfileName" : "accessProfileName",
"invoiceNumber" : "invoiceNumber",
"description" : "description",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"vendorName" : "vendorName",
"poNumber" : "poNumber"
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/purchases/orders/{id}Get one order by its identifier (ordersGetOrderById)
Path parameters
id (required)
Path Parameter — Order Id
Query parameters
fields (optional)
Query Parameter — The column names of the fields to return
Return type
Object
Example data
Content-Type: application/json
{ }Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success Object400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUserGroups
Up
get /api/v1/groups/users/{id}Get one user group by its identifier (userGroupsGetUserGroupById)
Path parameters
id (required)
Path Parameter — User Group Id
Query parameters
fields (optional)
Query Parameter — The column names of the fields to return
Return type
Example data
Content-Type: application/json
{
"userGroupId" : 0,
"path" : "path",
"name" : "name",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ]
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success UserGroupDto400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/groups/users/{id}/membersGet a list of users in a user group (userGroupsGetUserGroupMembers)
Path parameters
id (required)
Path Parameter — User Group Id
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[UserDto]
Example data
Content-Type: application/json
[ {
"firstName" : "firstName",
"lastName" : "lastName",
"domainName" : "domainName",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"userName" : "userName",
"userId" : 0
}, {
"firstName" : "firstName",
"lastName" : "lastName",
"domainName" : "domainName",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"userName" : "userName",
"userId" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/groups/usersGet a list of user groups (userGroupsGetUserGroups)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[UserGroupDto]
Example data
Content-Type: application/json
[ {
"userGroupId" : 0,
"path" : "path",
"name" : "name",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ]
}, {
"userGroupId" : 0,
"path" : "path",
"name" : "name",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ]
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUsers
Up
get /api/v1/users/{id}Get one user by its identifier (usersGetUserById)
Path parameters
id (required)
Path Parameter — User Id
Query parameters
fields (optional)
Query Parameter — The column names of the fields to return
Return type
Example data
Content-Type: application/json
{
"firstName" : "firstName",
"lastName" : "lastName",
"domainName" : "domainName",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"userName" : "userName",
"userId" : 0
}Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success UserDto400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/users/{id}/groupsGet a list of groups to which a user is associated (usersGetUserGroupsByUserId)
Path parameters
id (required)
Path Parameter — User Id
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[UserGroupDto]
Example data
Content-Type: application/json
[ {
"userGroupId" : 0,
"path" : "path",
"name" : "name",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ]
}, {
"userGroupId" : 0,
"path" : "path",
"name" : "name",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ]
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorUp
get /api/v1/usersGet list of users (usersGetUsers)
Query parameters
page (optional)
Query Parameter — The 1-based page number of the paged results to return
pageSize (optional)
Query Parameter — The number of records in each page
sort (optional)
Query Parameter — The column names and directions for sorting the results
filter (optional)
Query Parameter — A record-selection specification
fields (optional)
Query Parameter — The column names of the fields to return
Return type
array[UserDto]
Example data
Content-Type: application/json
[ {
"firstName" : "firstName",
"lastName" : "lastName",
"domainName" : "domainName",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"userName" : "userName",
"userId" : 0
}, {
"firstName" : "firstName",
"lastName" : "lastName",
"domainName" : "domainName",
"links" : [ {
"method" : "method",
"rel" : "rel",
"href" : "href"
}, {
"method" : "method",
"rel" : "rel",
"href" : "href"
} ],
"userName" : "userName",
"userId" : 0
} ]Produces
This API call produces the following media types according to the Accept request header; the media type will be conveyed by the Content-Type response header.application/json
Responses
200
Success400
Bad Request String401
Unauthorized404
Not Found String500
InternalServerErrorModels
MethodsTable of Contents
AssignmentDtoComputerGroupDtoLineItemDtoLinkMaintenanceItemDtoOrderDtoSoftwareItemDtoUserDtoUserGroupDto
AssignmentDtoUp
An assignment is a way to split up a line item into multiple pieces so that each piece can be related to a different person, computer, or group.
A software line item, for example, can be assigned to a computer;
this implies that a per-computer sort of license purchased by the line item is intended to be used on that computer.
An assignment also provides a way to record the serial number or activation key of the thing assigned.
assignmentId (optional)
Integer Assignment identifier format: int32
quantity (optional)
Integer How many things are assigned format: int32
itemType (optional)
String "Software" or "Hardware" item type name
serialNumber (optional)
String Serial number of thing assigned
assignedToName (optional)
String User or computer name
assignedToType (optional)
String "User" or "Computer"
assignedToGroupName (optional)
String Name of group assigned to (or empty)
assignedToGroupType (optional)
String "User" or "Computer"
links (optional)
array[Link] Links to related information
ComputerGroupDtoUp
The Groups that Computers can be added to
computerGroupId (optional)
Integer Group identifier format: int32
name (optional)
String Group short name
path (optional)
String Full path name to this group
links (optional)
array[Link] Links to related information
LineItemDtoUp
A line item is a purchasing record related to a single kind of thing (software, hardware, etc.).
Each line item is related to a single parent order.
lineItemId (optional)
Integer Line item surrogate key format: int32
name (optional)
String Line item name
description (optional)
String Line item description
notes (optional)
String Line item notes
manufacturerName (optional)
String Item manufacturer name
partNumber (optional)
String Manufacturer part number
status (optional)
String Status (as in "ordered", "received", "retired", etc.)
contractNumber (optional)
String Governing contract number
type (optional)
String Line item type ("hardware", "software", etc.)
quantity (optional)
Integer Number of things ordered with this line item format: int32
unitPrice (optional)
Double Price per item (local currency) format: double
links (optional)
array[Link] Links to related information
MaintenanceItemDtoUp
A purchasing record related to a single kind of maintenance item (software or hardware). Each line item is related to a single parent order.
startDate (optional)
Date Maintenance period start date format: date-time
endDate (optional)
Date Maintenance period end date format: date-time
lineItemId (optional)
Integer Line item surrogate key format: int32
name (optional)
String Line item name
description (optional)
String Line item description
notes (optional)
String Line item notes
manufacturerName (optional)
String Item manufacturer name
partNumber (optional)
String Manufacturer part number
status (optional)
String Status (as in "ordered", "received", "retired", etc.)
contractNumber (optional)
String Governing contract number
type (optional)
String Line item type ("hardware", "software", etc.)
quantity (optional)
Integer Number of things ordered with this line item format: int32
unitPrice (optional)
Double Price per item (local currency) format: double
links (optional)
array[Link] Links to related information
OrderDtoUp
An order is a collection of line items with a date, a name, and other descriptive information.
There�s no distinction between purchases and leases, and there�s no lease information available.
orderId (optional)
Integer Order identifier format: int32
date (optional)
Date Date on which order was placed format: date-time
orderNumber (optional)
String Order identifier supplied by the end user
description (optional)
String Order description supplied by end user
poNumber (optional)
String Customer's purchase order number
invoiceNumber (optional)
String Vendor's invoice number
vendorName (optional)
String Vendor name
accessProfileName (optional)
String Access profile (if any) to which this order belongs
links (optional)
array[Link] Links to related information
SoftwareItemDtoUp
A purchasing record related to a single software item. Each line item is related to a single parent order.
licenseType (optional)
String Name of license type selected for this line item
isUpgradeLicense (optional)
Boolean True if this is marked as a license upgrade
lineItemId (optional)
Integer Line item surrogate key format: int32
name (optional)
String Line item name
description (optional)
String Line item description
notes (optional)
String Line item notes
manufacturerName (optional)
String Item manufacturer name
partNumber (optional)
String Manufacturer part number
status (optional)
String Status (as in "ordered", "received", "retired", etc.)
contractNumber (optional)
String Governing contract number
type (optional)
String Line item type ("hardware", "software", etc.)
quantity (optional)
Integer Number of things ordered with this line item format: int32
unitPrice (optional)
Double Price per item (local currency) format: double
links (optional)
array[Link] Links to related information
UserDtoUp
Users are people who use computers or software or other things in the customer�s environment.
Users need not interact directly with CAM.
userId (optional)
Integer User identifier format: int32
userName (optional)
String Users name
domainName (optional)
String Domain name in which the user name is defined
firstName (optional)
String Given first name
lastName (optional)
String Given last name
links (optional)
array[Link] Links to related information
UserGroupDtoUp
Users belong to groups.
Groups are organizational units usually defined in the customer�s Active Directory
userGroupId (optional)
Integer Group identifier format: int32
name (optional)
String Group short name
path (optional)
String Full path name to this group
links (optional)
array[Link] Links to related information