openapi: 3.2.0 info: title: Avnet Property API version: '1.0' description: 'Operations tagged Property across 2 of this provider''s published API definitions: avnet-iotconnect-master-aws-prod-swagger.json, avnet-iotconnect-master-azure-prod-swagger.json. Each path carries the servers of the definition it was published in.' security: - Bearer: [] tags: - name: Property description: Property Api List paths: /api/v2.1/property-type: get: tags: - Property summary: Get property type list description: 'Property APIs allow you to create and manage custom properties. Custom properties have property types. Examples of property types are device, user, entity. This API endpoint provides you the list of property types. You need these property types at the time of creating a property.' responses: '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ConflictErrorModel' '200': description: Indicates that property type list is loaded successfully. content: application/json: schema: $ref: '#/components/schemas/PropertyTypeListResponse' '204': description: Indicates that the request has been successfully processed and no records found. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server Company doesn''t exist, Logged in user is invalid etc.' operationId: getApiV21PropertyType x-operation-id-source: derived /api/v2.1/property-type/{propertyTypeId}: get: tags: - Property summary: Get properties for property type description: This API endpoint gives you the list of available properties under the given property type. For that, you need to send propertyTypeGuid in request url. parameters: - name: propertyTypeId in: path description: Property Type Guid required: true schema: type: string format: uuid responses: '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ConflictErrorModel' '200': description: Indicates that property list is loaded successfully. content: application/json: schema: $ref: '#/components/schemas/PropertyListResponse' '204': description: Indicates that the request has been successfully processed and no records found. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server Property type doesn''t exist, Company doesn''t exist, Logged in user is invalid etc.' operationId: getApiV21PropertyTypeByPropertyTypeId x-operation-id-source: derived /api/v2.1/Property/field-type: get: tags: - Property summary: Get field type list description: This API endpoint gives you the list of valid field types. These field types are used to decide which HTML input control needs to be used for this property in UI. Examples of field types are Text, TextArea. responses: '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ConflictErrorModel' '200': description: Indicates that field type list is loaded successfully. content: application/json: schema: $ref: '#/components/schemas/FieldTypeListResponse' operationId: getApiV21PropertyFieldType x-operation-id-source: derived /api/v2.1/Property: post: tags: - Property summary: Add new property description: This API endpoint allows you to create a new custom property. responses: '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ConflictErrorModel' '200': description: Indicates that property is created successfully and returns created property id. content: application/json: schema: $ref: '#/components/schemas/PropertyCreateResponse' '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server Property type doesn''t exist, Duplicate property name, Company doesn''t exist, User is not valid etc.' requestBody: content: application/json: schema: $ref: '#/components/schemas/PropertyCreateRequest' description: Json object operationId: postApiV21Property x-operation-id-source: derived /api/v2.1/Property/{propertyGuid}: put: tags: - Property summary: Update a property description: This API endpoint allows you to update a custom property. For that, you need to send propertyGuid in request url and updated property details in the request body. parameters: - name: propertyGuid in: path description: Property guid required: true schema: type: string format: uuid responses: '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ConflictErrorModel' '200': description: Indicates that property is updated successfully. content: application/json: schema: $ref: '#/components/schemas/PropertyUpdateResponse' '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server Property doesn''t exist, Duplicate property name, Company doesn''t exist, User is not valid etc.' requestBody: content: application/json: schema: $ref: '#/components/schemas/PropertyUpdateRequest' description: Json object operationId: putApiV21PropertyByPropertyGuid x-operation-id-source: derived /api/v2.1/property-type/{propertyTypeId}/property/{propertyId}: delete: tags: - Property summary: Delete a property description: This API endpoint allows you to delete a custom property. For that, you need to send propertyTypeGuid and propertyGuid in request url. parameters: - name: propertyTypeId in: path description: Property Type Guid required: true schema: type: string format: uuid - name: propertyId in: path description: Property Guid required: true schema: type: string format: uuid responses: '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ConflictErrorModel' '200': description: Indicates that property is deleted successfully. content: application/json: schema: $ref: '#/components/schemas/PropertyDeleteResponse' '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server Property doesn''t exist, Company doesn''t exist, User is not valid etc.' operationId: deleteApiV21PropertyTypeByPropertyTypeIdPropertyByPropertyId x-operation-id-source: derived get: tags: - Property summary: Get single property description description: This API endpoint gives you a detailed description of a property. For that, you need to send propertyTypeGuid and propertyGuid in request url. parameters: - name: propertyTypeId in: path description: Property Type Guid required: true schema: type: string format: uuid - name: propertyId in: path description: Property Guid required: true schema: type: string format: uuid responses: '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ConflictErrorModel' '200': description: Indicates that property detail is loaded successfully. content: application/json: schema: $ref: '#/components/schemas/PropertyDetailResponse' '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server Property doesn''t exist, Company doesn''t exist, Logged in user is invalid etc.' operationId: getApiV21PropertyTypeByPropertyTypeIdPropertyByPropertyId x-operation-id-source: derived /api/v2.1/Property/custom-field-type: get: tags: - Property summary: Get field type list description: This API endpoint gives you the list of valid field types. These field types are used to decide which HTML input control needs to be used for this property in UI. Examples of field types are Text, TextArea. responses: '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ConflictErrorModel' '200': description: Indicates that field type list is loaded successfully. content: application/json: schema: $ref: '#/components/schemas/FieldTypeListResponse' operationId: getApiV21PropertyCustomFieldType x-operation-id-source: derived /api/v2/property-type: get: tags: - Property summary: Get property type list description: 'Property APIs allow you to create and manage custom properties. Custom properties have property types. Examples of property types are device, user, entity. This API endpoint provides you the list of property types. You need these property types at the time of creating a property.' responses: '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ConflictErrorModel' '200': description: Indicates that property type list is loaded successfully. content: application/json: schema: $ref: '#/components/schemas/PropertyTypeListResponse' '204': description: Indicates that the request has been successfully processed and no records found. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server Company doesn''t exist, Logged in user is invalid etc.' operationId: getApiV2PropertyType x-operation-id-source: derived /api/v2/property-type/{propertyTypeId}: get: tags: - Property summary: Get properties for property type description: This API endpoint gives you the list of available properties under the given property type. For that, you need to send propertyTypeGuid in request url. parameters: - name: propertyTypeId in: path description: Property Type Guid required: true schema: type: string format: uuid responses: '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ConflictErrorModel' '200': description: Indicates that property list is loaded successfully. content: application/json: schema: $ref: '#/components/schemas/PropertyListResponse' '204': description: Indicates that the request has been successfully processed and no records found. '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server Property type doesn''t exist, Company doesn''t exist, Logged in user is invalid etc.' operationId: getApiV2PropertyTypeByPropertyTypeId x-operation-id-source: derived /api/v2/Property/field-type: get: tags: - Property summary: Get field type list description: This API endpoint gives you the list of valid field types. These field types are used to decide which HTML input control needs to be used for this property in UI. Examples of field types are Text, TextArea. responses: '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ConflictErrorModel' '200': description: Indicates that field type list is loaded successfully. content: application/json: schema: $ref: '#/components/schemas/FieldTypeListResponse' operationId: getApiV2PropertyFieldType x-operation-id-source: derived /api/v2/Property: post: tags: - Property summary: Add new property description: This API endpoint allows you to create a new custom property. responses: '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ConflictErrorModel' '200': description: Indicates that property is created successfully and returns created property id. content: application/json: schema: $ref: '#/components/schemas/PropertyCreateResponse' '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server Property type doesn''t exist, Duplicate property name, Company doesn''t exist, User is not valid etc.' requestBody: content: application/json: schema: $ref: '#/components/schemas/PropertyCreateRequest' description: Json object operationId: postApiV2Property x-operation-id-source: derived /api/v2/Property/{propertyGuid}: put: tags: - Property summary: Update a property description: This API endpoint allows you to update a custom property. For that, you need to send propertyGuid in request url and updated property details in the request body. parameters: - name: propertyGuid in: path description: Property guid required: true schema: type: string format: uuid responses: '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ConflictErrorModel' '200': description: Indicates that property is updated successfully. content: application/json: schema: $ref: '#/components/schemas/PropertyUpdateResponse' '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server Property doesn''t exist, Duplicate property name, Company doesn''t exist, User is not valid etc.' requestBody: content: application/json: schema: $ref: '#/components/schemas/PropertyUpdateRequest' description: Json object operationId: putApiV2PropertyByPropertyGuid x-operation-id-source: derived /api/v2/property-type/{propertyTypeId}/property/{propertyId}: delete: tags: - Property summary: Delete a property description: This API endpoint allows you to delete a custom property. For that, you need to send propertyTypeGuid and propertyGuid in request url. parameters: - name: propertyTypeId in: path description: Property Type Guid required: true schema: type: string format: uuid - name: propertyId in: path description: Property Guid required: true schema: type: string format: uuid responses: '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ConflictErrorModel' '200': description: Indicates that property is deleted successfully. content: application/json: schema: $ref: '#/components/schemas/PropertyDeleteResponse' '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server Property doesn''t exist, Company doesn''t exist, User is not valid etc.' operationId: deleteApiV2PropertyTypeByPropertyTypeIdPropertyByPropertyId x-operation-id-source: derived get: tags: - Property summary: Get single property description description: This API endpoint gives you a detailed description of a property. For that, you need to send propertyTypeGuid and propertyGuid in request url. parameters: - name: propertyTypeId in: path description: Property Type Guid required: true schema: type: string format: uuid - name: propertyId in: path description: Property Guid required: true schema: type: string format: uuid responses: '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ConflictErrorModel' '200': description: Indicates that property detail is loaded successfully. content: application/json: schema: $ref: '#/components/schemas/PropertyDetailResponse' '409': description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server Property doesn''t exist, Company doesn''t exist, Logged in user is invalid etc.' operationId: getApiV2PropertyTypeByPropertyTypeIdPropertyByPropertyId x-operation-id-source: derived /api/v2/Property/custom-field-type: get: tags: - Property summary: Get field type list description: This API endpoint gives you the list of valid field types. These field types are used to decide which HTML input control needs to be used for this property in UI. Examples of field types are Text, TextArea. responses: '401': description: Indicates that authentication is failed because of the token is invalid or expired or missing. '403': description: Indicates that the user is not authorized to access this section. '412': description: Indicates that a condition set for this request is failed, and the request cannot be carried out. '500': description: Indicates that the request could not be carried out because of some technical error on the server. content: application/json: schema: $ref: '#/components/schemas/ConflictErrorModel' '200': description: Indicates that field type list is loaded successfully. content: application/json: schema: $ref: '#/components/schemas/FieldTypeListResponse' operationId: getApiV2PropertyCustomFieldType x-operation-id-source: derived components: schemas: PropertyList: type: object properties: guid: type: - string - 'null' readOnly: true name: type: - string - 'null' fieldType: type: - string - 'null' options: type: - string - 'null' propertytypeguid: type: - string - 'null' readOnly: true customfieldtypeguid: type: - string - 'null' readOnly: true additionalProperties: false PropertyDeleteResponse: type: object properties: data: type: - array - 'null' items: type: - object - 'null' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false PropertyDetail: type: object properties: guid: type: - string - 'null' readOnly: true name: type: - string - 'null' propertyTypeGuid: type: - string - 'null' readOnly: true companyGuid: type: - string - 'null' fieldType: type: - string - 'null' options: type: - string - 'null' isDeleted: type: boolean isSystem: type: boolean createdDate: type: string format: date-time createdBy: type: - string - 'null' readOnly: true updatedDate: type: string format: date-time updatedBy: type: - string - 'null' readOnly: true customFieldTypeGuid: type: - string - 'null' readOnly: true additionalProperties: false ErrorModel: type: object properties: param: type: - string - 'null' message: type: - string - 'null' additionalProperties: false ConflictErrorModel: type: object properties: status: type: integer format: int32 message: type: - string - 'null' error: type: - array - 'null' items: $ref: '#/components/schemas/ErrorModel' additionalProperties: false PropertyUpdateResponse: type: object properties: data: type: - array - 'null' items: type: - object - 'null' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false PropertyTypeListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/PropertyTypeList' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false FieldTypeListResponse: type: object properties: data: type: - array - 'null' items: type: - object - 'null' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false PropertyTypeList: type: object properties: guid: type: - string - 'null' readOnly: true name: type: - string - 'null' configkey: type: - string - 'null' additionalProperties: false PropertyUpdateRequest: required: - fieldType - name - propertyTypeGuid type: object properties: propertyTypeGuid: minLength: 1 type: string description: Property Type Guid name: minLength: 1 type: string description: Property Name fieldType: minLength: 1 type: string description: Property Field Type should be number, text, textarea, select, multiselect, date, time options: type: - string - 'null' description: Requires options list when field type is select or multiselect additionalProperties: false PropertyDetailResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/PropertyDetail' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false PropertyListResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/PropertyList' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false PropertyCreateResponse: type: object properties: data: type: - array - 'null' items: $ref: '#/components/schemas/PropertyCreate' status: enum: - 100 - 101 - 102 - 103 - 200 - 201 - 202 - 203 - 204 - 205 - 206 - 207 - 208 - 226 - 300 - 301 - 302 - 303 - 304 - 305 - 306 - 307 - 308 - 400 - 401 - 402 - 403 - 404 - 405 - 406 - 407 - 408 - 409 - 410 - 411 - 412 - 413 - 414 - 415 - 416 - 417 - 421 - 422 - 423 - 424 - 426 - 428 - 429 - 431 - 451 - 500 - 501 - 502 - 503 - 504 - 505 - 506 - 507 - 508 - 510 - 511 type: integer format: int32 message: type: - string - 'null' count: type: - integer - 'null' format: int64 additionalProperties: false PropertyCreate: type: object properties: newid: type: - string - 'null' additionalProperties: false PropertyCreateRequest: required: - fieldType - name - propertyTypeGuid type: object properties: customFieldTypeGuid: type: - string - 'null' propertyTypeGuid: minLength: 1 type: string description: Property Type Guid name: minLength: 1 type: string description: Property Name fieldType: minLength: 1 type: string description: Property Field Type should be number, text, textarea, select, multiselect, date, time options: type: - string - 'null' description: Requires options list when field type is select or multiselect additionalProperties: false securitySchemes: Bearer: type: apiKey description: Please enter JWT with Bearer into field name: Authorization in: header x-refined-from: - avnet-iotconnect-master-aws-prod-swagger.json - avnet-iotconnect-master-azure-prod-swagger.json