openapi: 3.0.1 info: title: MVISION ePO API - devices description: >- Device APIs
MVISION ePO manages different devices under system tree. The following APIs allow for the management of these devices.
(The APIs conform to the JSON:API specification.) contact: email: support@epo.mcafee.com license: name: Proprietary url: 'https://www.mcafee.com/enterprise/en-us/support/licensing-information.html' version: 1.0.0 x-definition-name: /epo/v2/devices paths: /epo/v2/devices: description: Apis for accessing the devices collections get: tags: - devices summary: 'Fetch all devices, using supplied criteria.' parameters: - $ref: '#/components/parameters/deviceFilter' - $ref: '#/components/parameters/deviceSort' - $ref: '#/components/parameters/deviceFields' - $ref: '#/components/parameters/include' - $ref: '#/components/parameters/pageOffset' - $ref: '#/components/parameters/pageLimit' responses: '200': description: Successful content: application/vnd.api+json: schema: $ref: '#/components/schemas/deviceList' '400': $ref: '#/components/responses/R400Response' '401': $ref: '#/components/responses/R401Response' '403': $ref: '#/components/responses/R403Response' '404': $ref: '#/components/responses/R404Response' '405': $ref: '#/components/responses/R405Response' '409': $ref: '#/components/responses/R409Response' '412': $ref: '#/components/responses/R412Response' '415': $ref: '#/components/responses/R415Response' '422': $ref: '#/components/responses/R422Response' '500': $ref: '#/components/responses/R500Response' x-scopes: - epo.device.r security: - OktaCustomAuthorizer: [] post: tags: - devices summary: Create new resource of type device description: Creates a new resource of type device requestBody: description: ' The following guidelines for POST requests must be followed 1. Post requests must not have the id field. Ids are assigned server side 2. For a relationship to be specified in the post, the related entity must already exist3. If there are no related entities existing, then populate an empty object for 1:1 and an empty array for 1: many ' content: application/vnd.api+json: schema: $ref: '#/components/schemas/device' required: true responses: '201': description: Successful content: application/vnd.api+json: schema: $ref: '#/components/schemas/device' '400': $ref: '#/components/responses/R400Response' '401': $ref: '#/components/responses/R401Response' '403': $ref: '#/components/responses/R403Response' '404': $ref: '#/components/responses/R404Response' '405': $ref: '#/components/responses/R405Response' '409': $ref: '#/components/responses/R409Response' '412': $ref: '#/components/responses/R412Response' '415': $ref: '#/components/responses/R415Response' '422': $ref: '#/components/responses/R422Response' '500': $ref: '#/components/responses/R500Response' x-scopes: - epo.device.w security: - OktaCustomAuthorizer: [] parameters: - $ref: '#/components/parameters/traceId' - $ref: '#/components/parameters/serviceTenantId' '/epo/v2/devices/{id}': description: Apis for accessing the devices collections get: tags: - devices summary: Fetch individual device using the id that is specified in the path. parameters: - $ref: '#/components/parameters/deviceFields' responses: '200': description: Successful content: application/vnd.api+json: schema: $ref: '#/components/schemas/device' '400': $ref: '#/components/responses/R400Response' '401': $ref: '#/components/responses/R401Response' '403': $ref: '#/components/responses/R403Response' '404': $ref: '#/components/responses/R404Response' '405': $ref: '#/components/responses/R405Response' '409': $ref: '#/components/responses/R409Response' '412': $ref: '#/components/responses/R412Response' '415': $ref: '#/components/responses/R415Response' '422': $ref: '#/components/responses/R422Response' '500': $ref: '#/components/responses/R500Response' x-scopes: - epo.device.r security: - OktaCustomAuthorizer: [] delete: tags: - devices summary: Delete a device using the idspecified in the path. description: Delete a device using the idspecified in the path. responses: '204': description: Deletion successful. '400': $ref: '#/components/responses/R400Response' '401': $ref: '#/components/responses/R401Response' '403': $ref: '#/components/responses/R403Response' '404': $ref: '#/components/responses/R404Response' '405': $ref: '#/components/responses/R405Response' '409': $ref: '#/components/responses/R409Response' '412': $ref: '#/components/responses/R412Response' '415': $ref: '#/components/responses/R415Response' '422': $ref: '#/components/responses/R422Response' '500': $ref: '#/components/responses/R500Response' x-scopes: - epo.device.w security: - OktaCustomAuthorizer: [] patch: tags: - devices summary: >- Updates an existing resource of type device where the id is specified in the path description: >- Updates an existing resource of type device where the id is specified in the path requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/device' required: true responses: '200': description: Successful content: application/vnd.api+json: schema: $ref: '#/components/schemas/device' '400': $ref: '#/components/responses/R400Response' '401': $ref: '#/components/responses/R401Response' '403': $ref: '#/components/responses/R403Response' '404': $ref: '#/components/responses/R404Response' '405': $ref: '#/components/responses/R405Response' '409': $ref: '#/components/responses/R409Response' '412': $ref: '#/components/responses/R412Response' '415': $ref: '#/components/responses/R415Response' '422': $ref: '#/components/responses/R422Response' '500': $ref: '#/components/responses/R500Response' x-scopes: - epo.device.w security: - OktaCustomAuthorizer: [] parameters: - $ref: '#/components/parameters/traceId' - $ref: '#/components/parameters/serviceTenantId' - $ref: '#/components/parameters/id' '/epo/v2/groups/{id}/devices': description: Apis for accessing the devices collections get: tags: - devices summary: Fetch all devices. parameters: - $ref: '#/components/parameters/deviceFilter' - $ref: '#/components/parameters/deviceSort' - $ref: '#/components/parameters/deviceFields' - $ref: '#/components/parameters/include' - $ref: '#/components/parameters/pageOffset' - $ref: '#/components/parameters/pageLimit' responses: '200': description: Successful content: application/vnd.api+json: schema: $ref: '#/components/schemas/deviceList' '400': $ref: '#/components/responses/R400Response' '401': $ref: '#/components/responses/R401Response' '403': $ref: '#/components/responses/R403Response' '404': $ref: '#/components/responses/R404Response' '405': $ref: '#/components/responses/R405Response' '409': $ref: '#/components/responses/R409Response' '412': $ref: '#/components/responses/R412Response' '415': $ref: '#/components/responses/R415Response' '422': $ref: '#/components/responses/R422Response' '500': $ref: '#/components/responses/R500Response' x-scopes: - epo.device.r security: - OktaCustomAuthorizer: [] parameters: - $ref: '#/components/parameters/traceId' - $ref: '#/components/parameters/serviceTenantId' - $ref: '#/components/parameters/id' '/epo/v2/groups/{id}/relationships/devices': get: tags: - devices summary: Fetches all relationships parameters: - $ref: '#/components/parameters/relationshipSort' - $ref: '#/components/parameters/pageOffset' - $ref: '#/components/parameters/pageLimit' responses: '200': description: Successful content: application/vnd.api+json: schema: $ref: '#/components/schemas/deviceRelMulti' '400': $ref: '#/components/responses/R400Response' '401': $ref: '#/components/responses/R401Response' '403': $ref: '#/components/responses/R403Response' '404': $ref: '#/components/responses/R404Response' '405': $ref: '#/components/responses/R405Response' '409': $ref: '#/components/responses/R409Response' '412': $ref: '#/components/responses/R412Response' '415': $ref: '#/components/responses/R415Response' '422': $ref: '#/components/responses/R422Response' '500': $ref: '#/components/responses/R500Response' x-scopes: - epo.grps.r security: - OktaCustomAuthorizer: [] parameters: - $ref: '#/components/parameters/traceId' - $ref: '#/components/parameters/serviceTenantId' - $ref: '#/components/parameters/id' '/epo/v2/tags/{id}/devices': description: Apis for accessing the devices collections get: tags: - devices summary: Fetch all devices. parameters: - $ref: '#/components/parameters/deviceFilter' - $ref: '#/components/parameters/deviceSort' - $ref: '#/components/parameters/deviceFields' - $ref: '#/components/parameters/include' - $ref: '#/components/parameters/pageOffset' - $ref: '#/components/parameters/pageLimit' responses: '200': description: Successful content: application/vnd.api+json: schema: $ref: '#/components/schemas/deviceList' '400': $ref: '#/components/responses/R400Response' '401': $ref: '#/components/responses/R401Response' '403': $ref: '#/components/responses/R403Response' '404': $ref: '#/components/responses/R404Response' '405': $ref: '#/components/responses/R405Response' '409': $ref: '#/components/responses/R409Response' '412': $ref: '#/components/responses/R412Response' '415': $ref: '#/components/responses/R415Response' '422': $ref: '#/components/responses/R422Response' '500': $ref: '#/components/responses/R500Response' x-scopes: - epo.device.r security: - OktaCustomAuthorizer: [] parameters: - $ref: '#/components/parameters/traceId' - $ref: '#/components/parameters/serviceTenantId' - $ref: '#/components/parameters/id' '/epo/v2/tags/{id}/relationships/devices': get: tags: - devices summary: Fetches all relationships parameters: - $ref: '#/components/parameters/relationshipSort' - $ref: '#/components/parameters/pageOffset' - $ref: '#/components/parameters/pageLimit' responses: '200': description: Successful content: application/vnd.api+json: schema: $ref: '#/components/schemas/deviceRelMulti' '400': $ref: '#/components/responses/R400Response' '401': $ref: '#/components/responses/R401Response' '403': $ref: '#/components/responses/R403Response' '404': $ref: '#/components/responses/R404Response' '405': $ref: '#/components/responses/R405Response' '409': $ref: '#/components/responses/R409Response' '412': $ref: '#/components/responses/R412Response' '415': $ref: '#/components/responses/R415Response' '422': $ref: '#/components/responses/R422Response' '500': $ref: '#/components/responses/R500Response' x-scopes: - epo.tags.r security: - OktaCustomAuthorizer: [] post: tags: - devices summary: Create relationship(s) requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/deviceRelUD' required: true responses: '201': description: Successful. '400': $ref: '#/components/responses/R400Response' '401': $ref: '#/components/responses/R401Response' '403': $ref: '#/components/responses/R403Response' '404': $ref: '#/components/responses/R404Response' '405': $ref: '#/components/responses/R405Response' '409': $ref: '#/components/responses/R409Response' '412': $ref: '#/components/responses/R412Response' '415': $ref: '#/components/responses/R415Response' '422': $ref: '#/components/responses/R422Response' '500': $ref: '#/components/responses/R500Response' x-scopes: - epo.tags.w security: - OktaCustomAuthorizer: [] delete: tags: - devices summary: Remove relationship requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/deviceRelUD' required: true responses: '204': description: Successful. '400': $ref: '#/components/responses/R400Response' '401': $ref: '#/components/responses/R401Response' '403': $ref: '#/components/responses/R403Response' '404': $ref: '#/components/responses/R404Response' '405': $ref: '#/components/responses/R405Response' '409': $ref: '#/components/responses/R409Response' '412': $ref: '#/components/responses/R412Response' '415': $ref: '#/components/responses/R415Response' '422': $ref: '#/components/responses/R422Response' '500': $ref: '#/components/responses/R500Response' x-scopes: - epo.tags.w security: - OktaCustomAuthorizer: [] patch: tags: - devices summary: Patch relationship requestBody: content: application/vnd.api+json: schema: $ref: '#/components/schemas/deviceRelUD' required: true responses: '200': description: Successful. '400': $ref: '#/components/responses/R400Response' '401': $ref: '#/components/responses/R401Response' '403': $ref: '#/components/responses/R403Response' '404': $ref: '#/components/responses/R404Response' '405': $ref: '#/components/responses/R405Response' '409': $ref: '#/components/responses/R409Response' '412': $ref: '#/components/responses/R412Response' '415': $ref: '#/components/responses/R415Response' '422': $ref: '#/components/responses/R422Response' '500': $ref: '#/components/responses/R500Response' x-scopes: - epo.tags.w security: - OktaCustomAuthorizer: [] parameters: - $ref: '#/components/parameters/traceId' - $ref: '#/components/parameters/serviceTenantId' - $ref: '#/components/parameters/id' components: schemas: Error: properties: message: type: string PaginationCursorLinks: properties: next: type: string description: Pagination links PaginationOffsetLinks: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links auditLog: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/auditLogAttributes' auditLogAttributes: properties: id: type: integer format: int64 type: type: string enum: - auditLogs attributes: properties: userId: type: integer format: int64 userName: type: string priority: type: integer format: int32 cmdName: type: string message: type: string success: type: boolean startTime: type: string format: date-time endTime: type: string format: date-time remoteAddress: type: string localAddress: type: string description: Attributes of the auditLog entity links: properties: self: type: string relationships: description: Relationships of the auditLog entity auditLogList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/auditLogAttributes' auditLogRelMulti: properties: data: type: array items: properties: type: type: string enum: - auditLogs id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 auditLogRelOne: properties: data: properties: type: type: string enum: - auditLogs id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 auditLogRelUD: properties: data: type: array items: properties: type: type: string enum: - auditLogs id: type: integer format: int64 clientTask: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/clientTaskAttributes' clientTaskAssignment: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/clientTaskAssignmentAttributes' clientTaskAssignmentAttributes: properties: id: type: integer format: int64 type: type: string enum: - clientTaskAssignments attributes: properties: taskObjectId: type: integer format: int64 taskScheduleId: type: integer format: int64 taskSlotId: type: integer format: int64 taskNodeId: type: integer format: int64 nodeType: type: integer format: int64 taskAssignmentFlag: type: integer format: int64 description: Attributes of the clientTaskAssignment entity links: properties: self: type: string relationships: properties: clientTaskAssignments: properties: links: properties: self: type: string related: type: string data: type: array items: properties: type: type: string id: type: string description: Relationships of the clientTaskAssignment entity clientTaskAssignmentList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/clientTaskAssignmentAttributes' clientTaskAssignmentRelMulti: properties: data: type: array items: properties: type: type: string enum: - clientTaskAssignments id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 clientTaskAssignmentRelOne: properties: data: properties: type: type: string enum: - clientTaskAssignments id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 clientTaskAssignmentRelUD: properties: data: type: array items: properties: type: type: string enum: - clientTaskAssignments id: type: integer format: int64 clientTaskAttributes: properties: id: type: integer format: int64 type: type: string enum: - clientTasks attributes: properties: uid: type: string format: uuid serverId: type: string taskTypeId: type: integer format: int64 name: type: string description: type: string taskObjectFlag: type: integer format: int64 supportedPlatforms: type: string simpleDeployment: type: string schedule: type: string description: Attributes of the clientTask entity links: properties: self: type: string relationships: properties: clientTasks: properties: links: properties: self: type: string related: type: string data: properties: type: type: string id: type: string description: Relationships of the clientTask entity clientTaskList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/clientTaskAttributes' clientTaskRelMulti: properties: data: type: array items: properties: type: type: string enum: - clientTasks id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 clientTaskRelOne: properties: data: properties: type: type: string enum: - clientTasks id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 clientTaskRelUD: properties: data: type: array items: properties: type: type: string enum: - clientTasks id: type: integer format: int64 clientTaskSchedule: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/clientTaskScheduleAttributes' clientTaskScheduleAttributes: properties: id: type: integer format: int64 type: type: string enum: - clientTaskSchedules attributes: properties: name: type: string description: Attributes of the clientTaskSchedule entity links: properties: self: type: string relationships: properties: clientTaskSchedules: properties: links: properties: self: type: string related: type: string data: type: array items: properties: type: type: string id: type: string description: Relationships of the clientTaskSchedule entity clientTaskScheduleList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/clientTaskScheduleAttributes' clientTaskScheduleRelMulti: properties: data: type: array items: properties: type: type: string enum: - clientTaskSchedules id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 clientTaskScheduleRelOne: properties: data: properties: type: type: string enum: - clientTaskSchedules id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 clientTaskScheduleRelUD: properties: data: type: array items: properties: type: type: string enum: - clientTaskSchedules id: type: integer format: int64 clientTaskScheduleSetting: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/clientTaskScheduleSettingAttributes' clientTaskScheduleSettingAttributes: properties: id: type: integer format: int64 type: type: string enum: - clientTaskScheduleSettings attributes: properties: taskScheduleId: type: integer format: int64 sectionName: type: string settingName: type: string settingValue: type: string description: Attributes of the clientTaskScheduleSetting entity links: properties: self: type: string relationships: description: Relationships of the clientTaskScheduleSetting entity clientTaskScheduleSettingList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/clientTaskScheduleSettingAttributes' clientTaskScheduleSettingRelMulti: properties: data: type: array items: properties: type: type: string enum: - clientTaskScheduleSettings id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 clientTaskScheduleSettingRelOne: properties: data: properties: type: type: string enum: - clientTaskScheduleSettings id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 clientTaskScheduleSettingRelUD: properties: data: type: array items: properties: type: type: string enum: - clientTaskScheduleSettings id: type: integer format: int64 clientTaskSetting: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/clientTaskSettingAttributes' clientTaskSettingAttributes: properties: id: type: integer format: int64 type: type: string enum: - clientTaskSettings attributes: properties: taskObjectId: type: integer format: int64 sectionName: type: string settingName: type: string settingValue: type: string description: Attributes of the clientTaskSetting entity links: properties: self: type: string relationships: description: Relationships of the clientTaskSetting entity clientTaskSettingList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/clientTaskSettingAttributes' clientTaskSettingRelMulti: properties: data: type: array items: properties: type: type: string enum: - clientTaskSettings id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 clientTaskSettingRelOne: properties: data: properties: type: type: string enum: - clientTaskSettings id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 clientTaskSettingRelUD: properties: data: type: array items: properties: type: type: string enum: - clientTaskSettings id: type: integer format: int64 clientTaskType: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/clientTaskTypeAttributes' clientTaskTypeAttributes: properties: id: type: integer format: int64 type: type: string enum: - clientTaskTypes attributes: properties: productCode: type: string taskType: type: string platformsSupported: type: string taskTypeFlag: type: integer format: int64 priority: type: integer format: int64 editUrl: type: string saveUrl: type: string summaryUrl: type: string taskPermission: type: string immutable: type: string description: Attributes of the clientTaskType entity links: properties: self: type: string relationships: description: Relationships of the clientTaskType entity clientTaskTypeList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/clientTaskTypeAttributes' clientTaskTypeRelMulti: properties: data: type: array items: properties: type: type: string enum: - clientTaskTypes id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 clientTaskTypeRelOne: properties: data: properties: type: type: string enum: - clientTaskTypes id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 clientTaskTypeRelUD: properties: data: type: array items: properties: type: type: string enum: - clientTaskTypes id: type: integer format: int64 deployment: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/deploymentAttributes' deploymentAttributes: properties: id: type: integer format: int64 type: type: string enum: - deployments attributes: properties: name: type: string description: type: string type: type: string taskObjectId: type: integer format: int64 taskScheduleId: type: integer format: int64 status: type: integer format: int64 everyPolicyEnforcement: type: string canPostpone: type: string numPostpones: type: integer format: int64 postponeExpiresAfter: type: integer format: int64 displayText: type: string autoUpdate: type: string description: Attributes of the deployment entity links: properties: self: type: string relationships: properties: deployments: properties: links: properties: self: type: string related: type: string data: type: array items: properties: type: type: string id: type: string description: Relationships of the deployment entity deploymentGroup: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/deploymentGroupAttributes' deploymentGroupAttributes: properties: id: type: integer format: int64 type: type: string enum: - deploymentGroups attributes: properties: deploymentId: type: integer format: int64 groupId: type: integer format: int64 description: Attributes of the deploymentGroup entity links: properties: self: type: string relationships: description: Relationships of the deploymentGroup entity deploymentGroupList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/deploymentGroupAttributes' deploymentGroupRelMulti: properties: data: type: array items: properties: type: type: string enum: - deploymentGroups id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 deploymentGroupRelOne: properties: data: properties: type: type: string enum: - deploymentGroups id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 deploymentGroupRelUD: properties: data: type: array items: properties: type: type: string enum: - deploymentGroups id: type: integer format: int64 deploymentList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/deploymentAttributes' deploymentPackage: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/deploymentPackageAttributes' deploymentPackageAttributes: properties: id: type: integer format: int64 type: type: string enum: - deploymentPackages attributes: properties: deploymentId: type: integer format: int64 packageId: type: string installCommandLine: type: string packageName: type: string actionChosen: type: string description: Attributes of the deploymentPackage entity links: properties: self: type: string relationships: description: Relationships of the deploymentPackage entity deploymentPackageList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/deploymentPackageAttributes' deploymentPackageRelMulti: properties: data: type: array items: properties: type: type: string enum: - deploymentPackages id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 deploymentPackageRelOne: properties: data: properties: type: type: string enum: - deploymentPackages id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 deploymentPackageRelUD: properties: data: type: array items: properties: type: type: string enum: - deploymentPackages id: type: integer format: int64 deploymentRelMulti: properties: data: type: array items: properties: type: type: string enum: - deployments id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 deploymentRelOne: properties: data: properties: type: type: string enum: - deployments id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 deploymentRelUD: properties: data: type: array items: properties: type: type: string enum: - deployments id: type: integer format: int64 deploymentTag: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/deploymentTagAttributes' deploymentTagAttributes: properties: id: type: integer format: int64 type: type: string enum: - deploymentTags attributes: properties: deploymentId: type: integer format: int64 tagId: type: integer format: int64 description: Attributes of the deploymentTag entity links: properties: self: type: string relationships: description: Relationships of the deploymentTag entity deploymentTagList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/deploymentTagAttributes' deploymentTagRelMulti: properties: data: type: array items: properties: type: type: string enum: - deploymentTags id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 deploymentTagRelOne: properties: data: properties: type: type: string enum: - deploymentTags id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 deploymentTagRelUD: properties: data: type: array items: properties: type: type: string enum: - deploymentTags id: type: integer format: int64 deploymentTaskAssignment: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/deploymentTaskAssignmentAttributes' deploymentTaskAssignmentAttributes: properties: id: type: integer format: int64 type: type: string enum: - deploymentTaskAssignments attributes: properties: deploymentId: type: integer format: int64 taskAssignmentId: type: integer format: int64 description: Attributes of the deploymentTaskAssignment entity links: properties: self: type: string relationships: description: Relationships of the deploymentTaskAssignment entity deploymentTaskAssignmentList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/deploymentTaskAssignmentAttributes' deploymentTaskAssignmentRelMulti: properties: data: type: array items: properties: type: type: string enum: - deploymentTaskAssignments id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 deploymentTaskAssignmentRelOne: properties: data: properties: type: type: string enum: - deploymentTaskAssignments id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 deploymentTaskAssignmentRelUD: properties: data: type: array items: properties: type: type: string enum: - deploymentTaskAssignments id: type: integer format: int64 device: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/deviceAttributes' deviceAttributes: properties: id: type: integer format: int64 type: type: string enum: - devices attributes: properties: name: type: string description: This is computer name parentId: type: integer format: int64 agentGuid: type: string lastUpdate: type: string format: date-time agentState: type: integer format: int64 nodePath: type: string agentPlatform: type: string agentVersion: type: string nodeCreatedDate: type: string format: date-time managed: type: string tenantId: type: integer format: int64 tags: type: string excludedTags: type: string managedState: type: integer format: int64 computerName: type: string domainName: type: string ipAddress: type: string osType: type: string osVersion: type: string cpuType: type: string cpuSpeed: type: integer format: int64 numOfCpu: type: integer format: int64 totalPhysicalMemory: type: integer format: int64 macAddress: type: string userName: type: string osPlatform: type: string ipHostName: type: string isPortable: type: string description: Attributes of the device entity links: properties: self: type: string relationships: properties: devices: properties: links: properties: self: type: string related: type: string data: type: array items: properties: type: type: string id: type: string description: Relationships of the device entity deviceList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/deviceAttributes' deviceRelMulti: properties: data: type: array items: properties: type: type: string enum: - devices id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 deviceRelOne: properties: data: properties: type: type: string enum: - devices id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 deviceRelUD: properties: data: type: array items: properties: type: type: string enum: - devices id: type: integer format: int64 epoTenant: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/epoTenantAttributes' epoTenantAttributes: properties: id: type: integer format: int64 type: type: string enum: - tenants attributes: properties: name: type: string uid: type: string defaultLocale: type: string partnerUid: type: string guid: type: string epoTenantGuid: type: string description: Attributes of the epoTenant entity links: properties: self: type: string relationships: description: Relationships of the epoTenant entity epoTenantList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/epoTenantAttributes' epoTenantRelMulti: properties: data: type: array items: properties: type: type: string enum: - tenants id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 epoTenantRelOne: properties: data: properties: type: type: string enum: - tenants id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 epoTenantRelUD: properties: data: type: array items: properties: type: type: string enum: - tenants id: type: integer format: int64 group: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/groupAttributes' groupAttributes: properties: id: type: integer format: int64 type: type: string enum: - groups attributes: properties: name: type: string nullable: false groupTypeId: type: integer format: int32 parentId: type: integer format: int64 l1ParentId: type: integer format: int64 l2ParentId: type: integer format: int64 notes: type: string nodePath: type: string nodeTextPath: type: string nodeTextPath2: type: string description: Attributes of the group entity links: properties: self: type: string relationships: properties: groups: properties: links: properties: self: type: string related: type: string data: type: array items: properties: type: type: string id: type: string description: Relationships of the group entity groupList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/groupAttributes' groupRelMulti: properties: data: type: array items: properties: type: type: string enum: - groups id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 groupRelOne: properties: data: properties: type: type: string enum: - groups id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 groupRelUD: properties: data: type: array items: properties: type: type: string enum: - groups id: type: integer format: int64 groupType: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/groupTypeAttributes' groupTypeAttributes: properties: id: type: integer format: int64 type: type: string enum: - groupTypes attributes: properties: name: type: string deprecated: type: string description: type: string description: Attributes of the groupType entity links: properties: self: type: string relationships: description: Relationships of the groupType entity groupTypeList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/groupTypeAttributes' groupTypeRelMulti: properties: data: type: array items: properties: type: type: string enum: - groupTypes id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 groupTypeRelOne: properties: data: properties: type: type: string enum: - groupTypes id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 groupTypeRelUD: properties: data: type: array items: properties: type: type: string enum: - groupTypes id: type: integer format: int64 installedProduct: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/installedProductAttributes' installedProductAttributes: properties: id: type: integer format: int64 type: type: string enum: - installedProducts attributes: properties: parentId: type: integer format: int64 productCode: type: string productFamilyName: type: string productSerialNum: type: string engineVer: type: string datVer: type: string extraDatNames: type: string language: type: string productVersion: type: string datDate: type: string installedPath: type: string servicepack: type: string hotfix: type: string licenseStatus: type: string expirationDate: type: string lastInstalled: type: string format: date-time engineVer64: type: string tenantId: type: integer format: int64 verProductMajor: type: integer format: int32 verProductMinor: type: integer format: int32 verProductRevision: type: integer format: int32 verProductBuild: type: integer format: int32 verEngine32Major: type: integer format: int32 verEngine32Minor: type: integer format: int32 verDAT32Major: type: integer format: int32 verDAT32Minor: type: integer format: int32 verEngine64Major: type: integer format: int32 verEngine64Minor: type: integer format: int32 verHotfix: type: integer format: int32 description: Attributes of the installedProduct entity links: properties: self: type: string relationships: description: Relationships of the installedProduct entity installedProductList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/installedProductAttributes' installedProductRelMulti: properties: data: type: array items: properties: type: type: string enum: - installedProducts id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 installedProductRelOne: properties: data: properties: type: type: string enum: - installedProducts id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 installedProductRelUD: properties: data: type: array items: properties: type: type: string enum: - installedProducts id: type: integer format: int64 masterCatalog: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/masterCatalogAttributes' masterCatalogAttributes: properties: id: type: integer format: int64 type: type: string enum: - masterCatalog attributes: properties: productCode: type: string productName: type: string productVersion: type: string hotFixVersion: type: string engineVersion64: type: string productType: type: string language: type: string deploymentPath: type: string buildCmdline: type: string branch: type: string hidden: type: string platform: type: string distributionType: type: string dependencyProductId: type: string description: Attributes of the masterCatalog entity links: properties: self: type: string relationships: description: Relationships of the masterCatalog entity masterCatalogList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/masterCatalogAttributes' masterCatalogRelMulti: properties: data: type: array items: properties: type: type: string enum: - masterCatalog id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 masterCatalogRelOne: properties: data: properties: type: type: string enum: - masterCatalog id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 masterCatalogRelUD: properties: data: type: array items: properties: type: type: string enum: - masterCatalog id: type: integer format: int64 policy: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/policyAttributes' policyAssignment: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/policyAssignmentAttributes' policyAssignmentAttributes: properties: id: type: integer format: int64 type: type: string enum: - policyAssignments attributes: properties: policyObjectId: type: integer format: int64 nodeId: type: integer format: int64 nodeType: type: integer format: int64 slotId: type: integer format: int64 forceInheritance: type: boolean hidden: type: boolean description: Attributes of the policyAssignment entity links: properties: self: type: string relationships: description: Relationships of the policyAssignment entity policyAssignmentList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/policyAssignmentAttributes' policyAssignmentRelMulti: properties: data: type: array items: properties: type: type: string enum: - policyAssignments id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 policyAssignmentRelOne: properties: data: properties: type: type: string enum: - policyAssignments id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 policyAssignmentRelUD: properties: data: type: array items: properties: type: type: string enum: - policyAssignments id: type: integer format: int64 policyAttributes: properties: id: type: integer format: int64 type: type: string enum: - policies attributes: properties: typeId: type: integer format: int64 name: type: string editFlags: type: integer format: int64 policyDesc: type: string uid: type: string description: Attributes of the policy entity links: properties: self: type: string relationships: properties: policies: properties: links: properties: self: type: string related: type: string data: type: array items: properties: type: type: string id: type: string description: Relationships of the policy entity policyHistory: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/policyHistoryAttributes' policyHistoryAttributes: properties: id: type: integer format: int64 type: type: string enum: - policyHistories attributes: properties: timestamp: type: integer format: int64 comment: type: string policyObjectId: type: integer format: int64 policyTypeId: type: integer format: int64 policyObjectXml: type: string productVersion: type: string username: type: string status: type: integer format: int64 workflowId: type: integer format: int64 description: Attributes of the policyHistory entity links: properties: self: type: string relationships: description: Relationships of the policyHistory entity policyHistoryList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/policyHistoryAttributes' policyHistoryRelMulti: properties: data: type: array items: properties: type: type: string enum: - policyHistories id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 policyHistoryRelOne: properties: data: properties: type: type: string enum: - policyHistories id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 policyHistoryRelUD: properties: data: type: array items: properties: type: type: string enum: - policyHistories id: type: integer format: int64 policyList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/policyAttributes' policyProductToType: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/policyProductToTypeAttributes' policyProductToTypeAttributes: properties: id: type: integer format: int64 type: type: string enum: - policyProductToTypes attributes: properties: editUrl: type: string aggregateUrl: type: string legacyUi: type: boolean description: Attributes of the policyProductToType entity links: properties: self: type: string relationships: description: Relationships of the policyProductToType entity policyProductToTypeList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/policyProductToTypeAttributes' policyProductToTypeRelMulti: properties: data: type: array items: properties: type: type: string enum: - policyProductToTypes id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 policyProductToTypeRelOne: properties: data: properties: type: type: string enum: - policyProductToTypes id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 policyProductToTypeRelUD: properties: data: type: array items: properties: type: type: string enum: - policyProductToTypes id: type: integer format: int64 policyRelMulti: properties: data: type: array items: properties: type: type: string enum: - policies id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 policyRelOne: properties: data: properties: type: type: string enum: - policies id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 policyRelUD: properties: data: type: array items: properties: type: type: string enum: - policies id: type: integer format: int64 policySetting: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/policySettingAttributes' policySettingAttributes: properties: id: type: integer format: int64 type: type: string enum: - policySettings attributes: properties: typeId: type: integer format: int64 name: type: string paramInt: type: integer format: int64 paramStr: type: string description: Attributes of the policySetting entity links: properties: self: type: string relationships: properties: policySettings: properties: links: properties: self: type: string related: type: string data: type: array items: properties: type: type: string id: type: string description: Relationships of the policySetting entity policySettingList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/policySettingAttributes' policySettingRelMulti: properties: data: type: array items: properties: type: type: string enum: - policySettings id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 policySettingRelOne: properties: data: properties: type: type: string enum: - policySettings id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 policySettingRelUD: properties: data: type: array items: properties: type: type: string enum: - policySettings id: type: integer format: int64 policySettingValue: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/policySettingValueAttributes' policySettingValueAttributes: properties: id: type: integer format: int64 type: type: string enum: - policySettingValues attributes: properties: policySettingsId: type: integer format: int64 sectionName: type: string settingName: type: string settingValue: type: string lastUpdate: type: string format: date-time description: Attributes of the policySettingValue entity links: properties: self: type: string relationships: description: Relationships of the policySettingValue entity policySettingValueList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/policySettingValueAttributes' policySettingValueRelMulti: properties: data: type: array items: properties: type: type: string enum: - policySettingValues id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 policySettingValueRelOne: properties: data: properties: type: type: string enum: - policySettingValues id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 policySettingValueRelUD: properties: data: type: array items: properties: type: type: string enum: - policySettingValues id: type: integer format: int64 policyType: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/policyTypeAttributes' policyTypeAttributes: properties: id: type: integer format: int64 type: type: string enum: - policyTypes attributes: properties: categoryTextId: type: string featureTextId: type: string typeTextId: type: string description: Below are not required. we need Category and Feature ID singleton: type: boolean legacy: type: boolean assignmentMethod: type: integer format: int64 hidden: type: boolean description: Attributes of the policyType entity links: properties: self: type: string relationships: description: Relationships of the policyType entity policyTypeList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/policyTypeAttributes' policyTypeRelMulti: properties: data: type: array items: properties: type: type: string enum: - policyTypes id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 policyTypeRelOne: properties: data: properties: type: type: string enum: - policyTypes id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 policyTypeRelUD: properties: data: type: array items: properties: type: type: string enum: - policyTypes id: type: integer format: int64 productFamily: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/productFamilyAttributes' productFamilyAttributes: properties: id: type: string format: uuid type: type: string enum: - productFamilies attributes: properties: familyName: type: string nullable: false familyDispName: type: string productProperties: type: string description: Attributes of the productFamily entity links: properties: self: type: string relationships: description: Relationships of the productFamily entity productFamilyList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/productFamilyAttributes' productFamilyRelMulti: properties: data: type: array items: properties: type: type: string enum: - productFamilies id: type: string format: uuid links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 productFamilyRelOne: properties: data: properties: type: type: string enum: - productFamilies id: type: string format: uuid links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 productFamilyRelUD: properties: data: type: array items: properties: type: type: string enum: - productFamilies id: type: string format: uuid software: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/softwareAttributes' softwareAttributes: properties: id: type: integer format: int64 type: type: string enum: - softwares attributes: properties: productCode: type: string softwareName: type: string productVersion: type: string productFamily: type: string language: type: string platformsSupported: type: string extensionInstalled: type: boolean extensionContext: type: string description: Attributes of the software entity links: properties: self: type: string relationships: description: Relationships of the software entity softwareList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/softwareAttributes' softwareRelMulti: properties: data: type: array items: properties: type: type: string enum: - softwares id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 softwareRelOne: properties: data: properties: type: type: string enum: - softwares id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 softwareRelUD: properties: data: type: array items: properties: type: type: string enum: - softwares id: type: integer format: int64 tag: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/tagAttributes' tagAssignment: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/tagAssignmentAttributes' tagAssignmentAttributes: properties: id: type: string format: uuid type: type: string enum: - tagAssignments attributes: properties: sticky: type: boolean exclude: type: boolean description: Attributes of the tagAssignment entity links: properties: self: type: string relationships: description: Relationships of the tagAssignment entity tagAssignmentList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/tagAssignmentAttributes' tagAssignmentRelMulti: properties: data: type: array items: properties: type: type: string enum: - tagAssignments id: type: string format: uuid links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 tagAssignmentRelOne: properties: data: properties: type: type: string enum: - tagAssignments id: type: string format: uuid links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 tagAssignmentRelUD: properties: data: type: array items: properties: type: type: string enum: - tagAssignments id: type: string format: uuid tagAttributes: properties: id: type: integer format: int64 type: type: string enum: - tags attributes: properties: uniqueKey: type: string name: type: string nullable: false family: type: string nullable: false notes: type: string nullable: false criteria: type: string nullable: false whereClause: type: string nullable: false executeOnAsci: type: string nullable: false createdBy: type: string nullable: false createdOn: type: string nullable: false modifiedBy: type: string nullable: false modifiedOn: type: string nullable: false tagGroupId: type: integer format: int64 nullable: false description: Attributes of the tag entity links: properties: self: type: string relationships: properties: tags: properties: links: properties: self: type: string related: type: string data: type: array items: properties: type: type: string id: type: string description: Relationships of the tag entity tagGroup: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/tagGroupAttributes' tagGroupAttributes: properties: id: type: integer format: int64 type: type: string enum: - tagGroups attributes: properties: groupName: type: string nullable: false isHidden: type: boolean isReadOnly: type: boolean parentId: type: integer format: int64 description: Attributes of the tagGroup entity links: properties: self: type: string relationships: properties: tagGroups: properties: links: properties: self: type: string related: type: string data: type: array items: properties: type: type: string id: type: string description: Relationships of the tagGroup entity tagGroupList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/tagGroupAttributes' tagGroupRelMulti: properties: data: type: array items: properties: type: type: string enum: - tagGroups id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 tagGroupRelOne: properties: data: properties: type: type: string enum: - tagGroups id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 tagGroupRelUD: properties: data: type: array items: properties: type: type: string enum: - tagGroups id: type: integer format: int64 tagList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/tagAttributes' tagRelMulti: properties: data: type: array items: properties: type: type: string enum: - tags id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 tagRelOne: properties: data: properties: type: type: string enum: - tags id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 tagRelUD: properties: data: type: array items: properties: type: type: string enum: - tags id: type: integer format: int64 taskAssignmentsTags: properties: jsonapi: properties: version: type: string meta: type: object data: $ref: '#/components/schemas/taskAssignmentsTagsAttributes' taskAssignmentsTagsAttributes: properties: id: type: integer format: int64 type: type: string enum: - taskAssignmentsTags attributes: properties: taskAssignmentId: type: integer format: int64 tagId: type: integer format: int64 include: type: string description: Attributes of the taskAssignmentsTags entity links: properties: self: type: string relationships: description: Relationships of the taskAssignmentsTags entity taskAssignmentsTagsList: properties: jsonapi: properties: version: type: string meta: type: object properties: totalResourceCount: type: integer format: int32 Links: $ref: '#/components/schemas/PaginationOffsetLinks' data: type: array items: $ref: '#/components/schemas/taskAssignmentsTagsAttributes' taskAssignmentsTagsRelMulti: properties: data: type: array items: properties: type: type: string enum: - taskAssignmentsTags id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 taskAssignmentsTagsRelOne: properties: data: properties: type: type: string enum: - taskAssignmentsTags id: type: integer format: int64 links: properties: first: type: string last: type: string next: type: string prev: type: string description: Pagination links meta: type: object properties: totalResourceCount: type: integer format: int32 taskAssignmentsTagsRelUD: properties: data: type: array items: properties: type: type: string enum: - taskAssignmentsTags id: type: integer format: int64 responses: R400Response: description: Bad request content: application/vnd.api+json: schema: $ref: '#/components/schemas/Error' R401Response: description: Access Denied request content: application/vnd.api+json: schema: $ref: '#/components/schemas/Error' R403Response: description: Forbidden content: application/vnd.api+json: schema: $ref: '#/components/schemas/Error' R404Response: description: Not Found content: application/vnd.api+json: schema: $ref: '#/components/schemas/Error' R405Response: description: Method not allowed content: application/vnd.api+json: schema: $ref: '#/components/schemas/Error' R409Response: description: Conflict content: application/vnd.api+json: schema: $ref: '#/components/schemas/Error' R412Response: description: Precondition failed content: application/vnd.api+json: schema: $ref: '#/components/schemas/Error' R415Response: description: Unsupported media type content: application/vnd.api+json: schema: $ref: '#/components/schemas/Error' R422Response: description: Unprocessable entity content: application/vnd.api+json: schema: $ref: '#/components/schemas/Error' R500Response: description: Internal Server Error content: application/vnd.api+json: schema: $ref: '#/components/schemas/Error' parameters: id: name: id in: path description: Id of the instance required: true schema: type: string relatedId: name: relatedId in: path description: Id of the related instance required: true schema: type: string traceId: name: X-Trace-Id in: header description: >- Trace ID to be included in logs to help identify requests, called is responsible for making this unique per request or session. required: false schema: type: string format: uuid tenantId: name: X-Trace-Id in: header description: >- Trace ID to be included in logs to help identify requests, called is responsible for making this unique per request or session. required: false schema: type: string format: uuid serviceTenantId: name: X-Tenant-Id in: header description: Tenant ID when using a service token. required: false schema: type: string format: uuid pageOffset: name: 'page[offset]' in: query description: Page offset required: false explode: true schema: type: integer format: int64 default: 0 pageLimit: name: 'page[limit]' in: query description: Page limit required: false explode: true schema: type: integer format: int64 default: 20 pageCursor: name: 'page[cursor]' in: query description: >- Starting point, the value entered does not need to physically exist. In which case it will start from the closest to it. required: false explode: true schema: type: string include: name: include in: query description: Include related entity data in the response required: false explode: true schema: type: string relationshipSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: true schema: type: array items: type: string deploymentPackageFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - deploymentId - packageId - installCommandLine - packageName - actionChosen deploymentPackageFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, deploymentId, packageId required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' deploymentPackageSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - deploymentId - '-deploymentId' - packageId - '-packageId' policyProductToTypeFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - id - editUrl - aggregateUrl - legacyUi policyProductToTypeFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, id required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' policyProductToTypeSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - id - '-id' groupTypeFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - name - deprecated - description groupTypeFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' groupTypeSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string tagGroupFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - groupName - isHidden - isReadOnly - parentId - children - parent - tags tagGroupFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, groupName, parentId required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' tagGroupSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - groupName - '-groupName' clientTaskSettingFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - taskObjectId - sectionName - settingName - settingValue clientTaskSettingFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, taskObjectId, sectionName, settingName, settingValue required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' clientTaskSettingSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - taskObjectId - '-taskObjectId' - sectionName - '-sectionName' - settingName - '-settingName' - settingValue - '-settingValue' policySettingValueFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - policySettingsId - sectionName - settingName - settingValue - lastUpdate policySettingValueFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, policySettingsId, sectionName, settingName required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' policySettingValueSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - policySettingsId - '-policySettingsId' - sectionName - '-sectionName' - settingName - '-settingName' taskAssignmentsTagsFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - taskAssignmentId - tagId - include taskAssignmentsTagsFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, taskAssignmentId, tagId required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' taskAssignmentsTagsSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - taskAssignmentId - '-taskAssignmentId' - tagId - '-tagId' tagAssignmentFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - tagAssignmentKey - sticky - exclude - tag - device tagAssignmentFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: tagAssignmentKey, sticky, exclude, tag, device required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' tagAssignmentSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - tagAssignmentKey - '-tagAssignmentKey' - sticky - '-sticky' - exclude - '-exclude' - tag - '-tag' - device - '-device' groupFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - name - groupTypeId - parentId - l1ParentId - l2ParentId - notes - nodePath - nodeTextPath - nodeTextPath2 - subGroups - devices groupFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, name, groupTypeId, parentId required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' groupSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - name - '-name' - groupTypeId - '-groupTypeId' - parentId - '-parentId' masterCatalogFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - productCode - productName - productVersion - hotFixVersion - engineVersion64 - productType - language - deploymentPath - buildCmdline - branch - hidden - platform - distributionType - dependencyProductId masterCatalogFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' masterCatalogSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' tagFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - uniqueKey - name - family - notes - criteria - whereClause - executeOnAsci - createdBy - createdOn - modifiedBy - modifiedOn - tagGroupId - tagGroup - devices tagFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, name, family required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' tagSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - name - '-name' - family - '-family' deploymentTagFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - deploymentId - tagId deploymentTagFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, deploymentId, tagId required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' deploymentTagSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - deploymentId - '-deploymentId' - tagId - '-tagId' clientTaskScheduleFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - name - taskScheduleSettings - taskAssignments clientTaskScheduleFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' clientTaskScheduleSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' clientTaskAssignmentFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - taskObjectId - taskScheduleId - taskSlotId - taskNodeId - nodeType - taskAssignmentFlag - tasks - taskAssignmentsTags clientTaskAssignmentFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, taskObjectId, taskScheduleId, taskSlotId, taskNodeId, nodeType required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' clientTaskAssignmentSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - taskObjectId - '-taskObjectId' - taskScheduleId - '-taskScheduleId' - taskSlotId - '-taskSlotId' - taskNodeId - '-taskNodeId' - nodeType - '-nodeType' clientTaskScheduleSettingFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - taskScheduleId - sectionName - settingName - settingValue clientTaskScheduleSettingFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: taskScheduleId, sectionName, settingName required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' clientTaskScheduleSettingSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - taskScheduleId - '-taskScheduleId' - sectionName - '-sectionName' - settingName - '-settingName' softwareFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - productCode - softwareName - productVersion - productFamily - language - platformsSupported - extensionInstalled - extensionContext softwareFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, productCode, softwareName, productVersion, productFamily required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' softwareSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - productCode - '-productCode' - softwareName - '-softwareName' - productVersion - '-productVersion' - productFamily - '-productFamily' policySettingFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - typeId - name - paramInt - paramStr - policySettingValue policySettingFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, typeId, name, policySettingValue required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' policySettingSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - typeId - '-typeId' - name - '-name' - policySettingValue - '-policySettingValue' policyTypeFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - categoryTextId - featureTextId - typeTextId - singleton - legacy - assignmentMethod - hidden policyTypeFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, categoryTextId, featureTextId, typeTextId required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' policyTypeSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - categoryTextId - '-categoryTextId' - featureTextId - '-featureTextId' - typeTextId - '-typeTextId' deploymentTaskAssignmentFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - deploymentId - taskAssignmentId deploymentTaskAssignmentFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, deploymentId, taskAssignmentId required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' deploymentTaskAssignmentSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - deploymentId - '-deploymentId' - taskAssignmentId - '-taskAssignmentId' deploymentFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - name - description - type - taskObjectId - taskScheduleId - status - everyPolicyEnforcement - canPostpone - numPostpones - postponeExpiresAfter - displayText - autoUpdate - deploymentPackages - deploymentTags - deploymentGroups - tasks deploymentFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, name, taskObjectId required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' deploymentSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - name - '-name' - taskObjectId - '-taskObjectId' clientTaskTypeFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - productCode - taskType - platformsSupported - taskTypeFlag - priority - editUrl - saveUrl - summaryUrl - taskPermission - immutable clientTaskTypeFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, productCode, taskType required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' clientTaskTypeSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - productCode - '-productCode' - taskType - '-taskType' deviceFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - name - parentId - epoGroup - agentGuid - lastUpdate - agentState - nodePath - agentPlatform - agentVersion - nodeCreatedDate - managed - tenantId - tags - excludedTags - managedState - computerName - domainName - ipAddress - osType - osVersion - cpuType - cpuSpeed - numOfCpu - totalPhysicalMemory - macAddress - userName - osPlatform - ipHostName - isPortable - installedProducts - assignedTags deviceFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, name, parentId, agentGuid, lastUpdate, tenantId, computerName, ipAddress, assignedTags required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' deviceSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - name - '-name' - parentId - '-parentId' - agentGuid - '-agentGuid' - lastUpdate - '-lastUpdate' - tenantId - '-tenantId' - computerName - '-computerName' - ipAddress - '-ipAddress' - assignedTags - '-assignedTags' policyHistoryFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - timestamp - comment - policyObjectId - policyTypeId - policyObjectXml - productVersion - username - status - workflowId policyHistoryFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' policyHistorySort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' policyFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - typeId - name - editFlags - policyDesc - uid - policySettings - policyHistories - policyAssignments policyFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, typeId, name, uid, policyAssignments required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' policySort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - typeId - '-typeId' - name - '-name' - policySettings - '-policySettings' - policyHistories - '-policyHistories' - policyAssignments - '-policyAssignments' epoTenantFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - name - uid - defaultLocale - partnerUid - guid - epoTenantGuid epoTenantFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, epoTenantGuid required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' epoTenantSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - guid - '-guid' - epoTenantGuid - '-epoTenantGuid' deploymentGroupFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - deploymentId - groupId deploymentGroupFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, deploymentId, groupId required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' deploymentGroupSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - deploymentId - '-deploymentId' - groupId - '-groupId' auditLogFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - userId - userName - priority - cmdName - message - success - startTime - endTime - remoteAddress - localAddress auditLogFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, userId, cmdName, success, endTime required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' auditLogSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - userId - '-userId' - cmdName - '-cmdName' - success - '-success' - endTime - '-endTime' installedProductFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - parentId - productCode - productFamilyName - productSerialNum - engineVer - datVer - extraDatNames - language - productVersion - datDate - installedPath - servicepack - hotfix - licenseStatus - expirationDate - lastInstalled - engineVer64 - tenantId - verProductMajor - verProductMinor - verProductRevision - verProductBuild - verEngine32Major - verEngine32Minor - verDAT32Major - verDAT32Minor - verEngine64Major - verEngine64Minor - verHotfix installedProductFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, parentId required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' installedProductSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - parentId - '-parentId' clientTaskFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - uid - serverId - taskTypeId - name - description - taskObjectFlag - supportedPlatforms - simpleDeployment - schedule - taskSettings - taskAssignments - taskType clientTaskFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, serverId, taskTypeId, name, schedule required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' clientTaskSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - serverId - '-serverId' - taskTypeId - '-taskTypeId' - name - '-name' - schedule - '-schedule' policyAssignmentFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - policyObjectId - nodeId - nodeType - slotId - forceInheritance - hidden policyAssignmentFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, policyObjectId, nodeId, nodeType required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: type: object examples: FilterNone: $ref: '#/components/examples/FilterNone' FilterById: $ref: '#/components/examples/FilterById' FilterByIdUsingEQ: $ref: '#/components/examples/FilterByIdUsingEQ' FilterByIdMultipleValues: $ref: '#/components/examples/FilterByIdMultipleValues' FilterUsingAnd: $ref: '#/components/examples/FilterUsingAnd' FilterUsingOr: $ref: '#/components/examples/FilterUsingOr' policyAssignmentSort: name: sort in: query description: >- The sort query parameter orders the returned as per the sort order of the specified attribute name. Multiple attribute name may be provided command delimited. Also, the sort order is with the use of a hyphen prefix.Example ?sort=-a,b sort results descending a, ascending b required: false style: form explode: false schema: type: array items: type: string enum: - id - '-id' - policyObjectId - '-policyObjectId' - nodeId - '-nodeId' - nodeType - '-nodeType' productFamilyFields: name: fields in: query description: >- The fields query parameter takes in a separated list of attributes that must be returned in the response. Only those field that have been specified in the request should be returned. The fields may be both attributes and relationships required: false style: form explode: false schema: type: array items: type: string enum: - id - familyName - familyDispName - productProperties productFamilyFilter: name: filter in: query description: >- The filter query parameter can be used to return items based on a specified criteria. There are 2 forms in which this can be used. * Using a JSON filter expression, which can be used on this page with the **Try it out** feature * Such as: * **{ "attributeName": value }** * It also allows for complex expressions such as: * **{ "OR": {"attribute1": value1}, {"attribute2": value2}}** * Valid operators include: * EQ, NEQ, GT, GE, LT, LE * AND, OR, NOT * Using a basic expression, which can **not** be used on this page using the **Try it out** feature * Such as: * filter**[attributeName]=value** * multiple filter parameter can be chained together and are treated as ANDs, for example: * filter[attributeName]=value**&**filter[attribute2]=value2 * Valid operators include: * filter[attributeName][EQ]=value * filter[attributeName][NEQ]=value * filter[attributeName][GT]=value * filter[attributeName][GE]=value * filter[attributeName][LT]=value * filter[attributeName][LE]=value Filterable attributes: id, familyName required: false explode: true schema: type: string properties: AND: type: object NOT: type: object OR: