openapi: 3.2.0 info: contact: name: IXON B.V. url: https://www.ixon.cloud/ email: support@ixon.cloud description: API for the IXON Cloud Platform license: name: All Rights Reserved url: https://www.ixon.cloud/ title: IXON Asset List API version: 0.1.294 servers: - description: IXON Cloud platform server url: https://portal.ixon.cloud:443/api/ tags: - name: Asset List paths: /assets: get: tags: - Asset List summary: AssetList responses: '200': description: Success response. Data could be an object instead of a list when one value is returned content: application/json: schema: type: object required: - status - type - data properties: status: type: string default: success type: type: string moreAfter: type: - string - 'null' data: type: array items: type: object properties: publicId: maxLength: 12 minLength: 12 type: string company: type: object properties: publicId: type: string name: maxLength: 255 minLength: 1 type: string description: maxLength: 65535 minLength: 0 type: - string - 'null' order: maximum: 9223372036854776000 minimum: -9223372036854776000 type: integer format: int32 resourceVariant: type: object properties: publicId: maxLength: 12 minLength: 12 type: string company: type: object properties: publicId: type: string name: maxLength: 255 minLength: 1 type: string order: maximum: 9223372036854776000 minimum: -9223372036854776000 type: integer format: int32 slug: maxLength: 260 minLength: 1 type: - string - 'null' parent: type: - object - 'null' properties: publicId: type: string pageLinks: type: array items: type: object properties: publicId: maxLength: 12 minLength: 12 type: string agent: type: - object - 'null' properties: publicId: type: string asset: type: - object - 'null' properties: publicId: type: string menuItem: type: - object - 'null' properties: publicId: type: string page: type: object properties: publicId: type: string audience: type: - object - 'null' properties: publicId: maxLength: 12 minLength: 12 type: string name: maxLength: 255 minLength: 1 type: string description: maxLength: 255 minLength: 0 type: - string - 'null' custom: type: object default: type: boolean type: enum: - alarm - page - service type: - string - 'null' group: type: - object - 'null' properties: publicId: maxLength: 12 minLength: 12 type: string agent: type: - object - 'null' properties: publicId: type: string asset: type: - object - 'null' properties: publicId: type: string menuItem: type: - object - 'null' properties: publicId: type: string name: maxLength: 255 minLength: 1 type: string order: maximum: 65535 type: integer format: int32 custom: type: object memberships: type: array items: type: object properties: publicId: maxLength: 12 minLength: 12 type: string asset: type: object properties: publicId: type: string group: type: object properties: publicId: type: string card: type: object properties: publicId: type: string enabled: type: boolean aiAssistantEnabled: type: boolean aiAssistantUserGreeting: maxLength: 65535 minLength: 0 type: - string - 'null' custom: type: object agent: type: - object - 'null' properties: publicId: type: string appConfigs: type: array items: type: object properties: publicId: maxLength: 12 minLength: 12 type: string app: type: object properties: publicId: type: string asset: type: object properties: publicId: type: string values: maxLength: 65535 minLength: 0 type: - string - 'null' stateValues: maxLength: 65535 minLength: 0 type: - string - 'null' resources: type: array items: type: object properties: publicId: maxLength: 12 minLength: 12 type: string config: type: object properties: publicId: type: string name: maxLength: 255 minLength: 1 type: - string - 'null' resourcePublicId: maxLength: 12 minLength: 12 type: - string - 'null' resourceType: enum: - AgentDataTag type: string values: maxLength: 65535 minLength: 0 type: - string - 'null' stateValues: maxLength: 65535 minLength: 0 type: - string - 'null' slug: maxLength: 64 minLength: 1 type: string libraryAsset: type: - object - 'null' properties: publicId: type: string libraryVersion: type: - object - 'null' properties: publicId: maxLength: 12 minLength: 12 type: string name: maxLength: 255 minLength: 1 type: string library: type: object properties: publicId: type: string version: maximum: 4294967295 type: integer format: int32 description: maxLength: 65535 minLength: 0 type: - string - 'null' publishedBy: type: object properties: publicId: type: string publishedOn: type: string format: date-time renderedYaml: maxLength: 65535 minLength: 0 type: string latest: type: boolean isLibraryAsset: type: boolean hasChanges: type: boolean root: type: - object - 'null' properties: publicId: maxLength: 12 minLength: 12 type: string libraryRoot: type: - object - 'null' properties: publicId: maxLength: 12 minLength: 12 type: string location: type: - object - 'null' properties: name: maxLength: 255 minLength: 1 type: string latitude: type: string longitude: type: string timeZone: maxLength: 255 minLength: 1 type: - string - 'null' 4XX: $ref: '#/components/responses/4XXErrorResponse' parameters: - $ref: '#/components/parameters/apiVersion' - $ref: '#/components/parameters/apiApplication' - $ref: '#/components/parameters/apiCompany' - $ref: '#/components/parameters/apiBrandingOptional' - $ref: '#/components/parameters/fieldsParameter' - $ref: '#/components/parameters/filtersParameter' security: - bearerToken: [] operationId: getAssets x-operation-id-source: derived post: tags: - Asset List summary: AssetList responses: '201': description: Success response. Data could be an object instead of a list when one value is returned content: application/json: schema: type: object required: - status - type - data properties: status: type: string default: success type: type: string moreAfter: type: - string - 'null' data: type: array items: type: object properties: publicId: maxLength: 12 minLength: 12 type: string required: - publicId 4XX: $ref: '#/components/responses/4XXErrorResponse' parameters: - $ref: '#/components/parameters/apiVersion' - $ref: '#/components/parameters/apiApplication' - $ref: '#/components/parameters/apiCompany' - $ref: '#/components/parameters/apiBrandingOptional' requestBody: required: true content: application/json: schema: type: array items: type: object properties: name: maxLength: 255 minLength: 1 type: string description: maxLength: 65535 minLength: 0 type: - string - 'null' order: maximum: 9223372036854776000 minimum: -9223372036854776000 type: integer format: int32 resourceVariant: type: object properties: publicId: type: string slug: maxLength: 255 minLength: 1 type: string parent: type: - object - 'null' properties: publicId: type: string custom: type: object required: - name - resourceVariant description: You can give one item or a list of items security: - bearerToken: [] operationId: postAssets x-operation-id-source: derived patch: tags: - Asset List summary: AssetList responses: '200': description: Success response content: application/json: schema: type: object required: - status - type - data properties: status: type: string default: success type: type: string data: type: - object - 'null' 4XX: $ref: '#/components/responses/4XXErrorResponse' parameters: - $ref: '#/components/parameters/apiVersion' - $ref: '#/components/parameters/apiApplication' - $ref: '#/components/parameters/apiCompany' - $ref: '#/components/parameters/apiBrandingOptional' requestBody: required: true content: application/json: schema: type: array items: type: object properties: publicId: maxLength: 12 minLength: 12 type: string name: maxLength: 255 minLength: 1 type: string description: maxLength: 65535 minLength: 0 type: - string - 'null' order: maximum: 9223372036854776000 minimum: -9223372036854776000 type: integer format: int32 parent: type: - object - 'null' properties: publicId: type: string slug: maxLength: 260 minLength: 1 type: string card: type: object properties: publicId: type: string enabled: type: boolean aiAssistantEnabled: type: boolean aiAssistantUserGreeting: maxLength: 65535 minLength: 0 type: - string - 'null' custom: type: object agent: type: - object - 'null' properties: publicId: type: string location: type: - object - 'null' properties: name: maxLength: 255 minLength: 1 type: string latitude: type: string longitude: type: string timeZone: maxLength: 255 minLength: 1 type: - string - 'null' required: - publicId description: You can give one item or a list of items security: - bearerToken: [] operationId: patchAssets x-operation-id-source: derived delete: tags: - Asset List summary: AssetList responses: '200': description: Success response content: application/json: schema: type: object required: - status - type - data properties: status: type: string default: success type: type: string data: type: - object - 'null' 4XX: $ref: '#/components/responses/4XXErrorResponse' parameters: - $ref: '#/components/parameters/apiVersion' - $ref: '#/components/parameters/apiApplication' - $ref: '#/components/parameters/apiCompany' - $ref: '#/components/parameters/apiBrandingOptional' requestBody: required: true content: application/json: schema: type: array items: type: object properties: publicId: maxLength: 12 minLength: 12 type: string required: - publicId description: You can give one item or a list of items security: - bearerToken: [] operationId: deleteAssets x-operation-id-source: derived components: parameters: apiBrandingOptional: required: false description: Domain that provides the branding name: Api-Branding in: header schema: type: string pattern: .+(\..[^.]+) apiApplication: required: true description: Get your Application ID via support@ixon.cloud name: Api-Application in: header schema: type: string pattern: ^[0-9a-zA-Z]{12}$ apiCompany: required: true description: PublicId of the company name: Api-Company in: header schema: type: string pattern: ^(\d{4}-){4}\d{4}$ filtersParameter: required: false description: 'Filter the returned item(s). Format: operator(column,val) Possible operators are: lt, less, lte, lessorequal, eq, equals, ne, differs, gt, greater, gte, greaterorequal, in, ni, isnull, isnotnull, between, contains. Example: eq(publicId,"publicId_val")' name: filters in: query schema: type: array items: type: string apiVersion: required: true description: Version of the API to use name: Api-Version in: header schema: type: integer format: int32 enum: - 2 fieldsParameter: required: false description: 'Fields to select. Use "*" for all the top-level fields. Or check the "Success response" below for other fields. To get the fields of a subresource do subresource.field or for multiple fields of one subresource do subresource(field,field)' name: fields in: query schema: type: array items: type: string responses: 4XXErrorResponse: description: 4XX error response content: application/json: schema: type: object required: - status - type - data properties: status: type: string default: error type: type: string default: Error data: type: array items: $ref: '#/components/schemas/4XXErrorSchema' schemas: 4XXErrorSchema: type: object properties: message: type: string propertyName: type: - string - 'null' listIndex: type: - integer - 'null' format: int32 required: - message securitySchemes: bearerToken: type: http description: Bearer token created by the endpoint "POST AccessTokenList" scheme: bearer x-samples-languages: - curl - ruby - javascript - python - powershell