openapi: 3.2.0
info:
title: Avnet File API
version: '1.0'
description: 'Operations tagged File across 2 of this provider''s published API definitions: avnet-iotconnect-file-aws-prod-swagger.json, avnet-iotconnect-file-azure-prod-swagger.json. Each path carries the servers of the definition it was published in.'
security:
- Bearer: []
tags:
- name: File
description: File Api List
paths:
/api/v2.1/File:
post:
tags:
- File
summary: Upload a file
description: This API endpoint allows you to upload files on the cloud. You can upload different files like user profile, device image, firmware file etc. For that, you need to send ModuleType, defining the type of file. The fileRefGuid is a reference guid, saying a file belongs to which module. For example, for a user profile, it requires a user guid to define that to which user the file belongs.
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the file uploaded successfully and returns file details.
content:
application/json:
schema:
$ref: '#/components/schemas/FileAddResponse'
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
invalid logged user or company.'
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
fileRefGuid:
type: string
format: uuid
description: "Reference Guid. \n Eg.
- deviceGuid for deviceimage
- companyGuid for companylogo
- firmwareUpgradeGuid for firmware
- userGuid for userprofile
- importBatchGuid for importbatch
- solutionGuid for solutionimage
- deviceCertificateGuid for devicecertificate
- any guid for custom
- moduleVersionGuid for module
- dashboardWidgetGuid for widgetimage
- dashboardBackgroundGuid for dashboardimage
"
Tag:
type: string
description: Tag of file
ModuleType:
type: string
description: "Module type should be one of below items \n- deviceimage
- companylogo
- firmware
- userprofile
- importbatch
- solutionimage
- devicecertificate
- custom
- module
- widgetimage
- deviceupdate
- ggComponentArtifact
- ggComponentRecipe
- sagemakerModule
"
fileData:
type: string
description: Upload new file
format: binary
CompanyGuid:
type: string
format: uuid
description: Company Guid.
required:
- fileRefGuid
- ModuleType
operationId: postApiV21File
x-operation-id-source: derived
/api/v2.1/File/{fileGuid}:
put:
tags:
- File
summary: Update File by file guid
description: This API endpoint lets you update a file on the cloud. For that, you need to send fileGuid in request url and updated file in the request body.
parameters:
- name: fileGuid
in: path
description: File Guid
required: true
schema:
type: string
format: uuid
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the file updated successfully and returns updated file details.
content:
application/json:
schema:
$ref: '#/components/schemas/FileUpdateResponse'
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
invalid logged user or company.'
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
RunTime:
type: string
ModuleType:
type: string
description: "Module type should be one of below items \n- deviceimage
- companylogo
- firmware
- userprofile
- importbatch
- solutionimage
- devicecertificate
- custom
- module
- widgetimage
- deviceupdate
- ggComponentArtifact
- ggComponentRecipe
- sagemakerModule
"
fileData:
type: string
description: Upload new file
format: binary
CompanyGuid:
type: string
format: uuid
description: Company Guid.
required:
- ModuleType
operationId: putApiV21FileByFileGuid
x-operation-id-source: derived
/api/v2.1/File/{moduleType}/{fileGuid}:
delete:
tags:
- File
summary: Delete a file
description: This API endpoint permits you to delete a file from the cloud. For that, you need to send modelType and fileGuid in request url.
parameters:
- name: moduleType
in: path
description: 'Module type should be one of below items
- deviceimage
- companylogo
- firmware
- userprofile
- importbatch
- solutionimage
- devicecertificate
- custom
- module
- widgetimage
- deviceupdate
- ggComponentArtifact
- ggComponentRecipe
'
required: true
schema:
type: string
- name: fileGuid
in: path
description: File Guid
required: true
schema:
type: string
format: uuid
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the file deleted successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/FileDeleteResponse'
'204':
description: Indicates that the file not found.
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
invalid logged user or company.'
operationId: deleteApiV21FileByModuleTypeByFileGuid
x-operation-id-source: derived
/api/v2.1/File/{moduleType}/{fileRefGuid}:
get:
tags:
- File
summary: Get file list
description: This API endpoint allows you to download files from the cloud. For that, you need to send receipeModuleType and fileRefGuid in request url.
parameters:
- name: moduleType
in: path
description: 'Module type should be one of below items
- deviceimage
- companylogo
- firmware
- userprofile
- importbatch
- solutionimage
- devicecertificate
- custom
- module
- widgetimage
- deviceupdate
- ggComponentArtifact
- ggComponentRecipe
'
required: true
schema:
type: string
- name: fileRefGuid
in: path
description: Reference Guid.Eg.- deviceGuid for deviceimage
- companyGuid for companylogo
- firmwareUpgradeGuid for firmware
- userGuid for userprofile
- importBatchGuid for importbatch
- solutionGuid for solutionimage
- deviceCertificateGuid for devicecertificate
- any guid for custom
- moduleGuid for module
- dashboardWidgetGuid for widgetimage
required: true
schema:
type: string
format: uuid
- name: sasUrl
in: query
schema:
type: boolean
- name: runTime
in: query
schema:
type: string
- name: wirelessDeviceType
in: query
schema:
type: integer
format: int32
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the file list received successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/FileDeleteResponse'
'204':
description: Indicates that the file list not found.
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
invalid logged user or company.'
operationId: getApiV21FileByModuleTypeByFileRefGuid
x-operation-id-source: derived
/api/v2.1/File/{uniqueId}:
get:
tags:
- File
summary: Get device image file list
description: This API endpoint allows you to download files from the cloud. For that, you need to send receipeModuleType and fileRefGuid in request url.
parameters:
- name: uniqueId
in: path
description: uniqueId
required: true
schema:
type: string
- name: parentUniqueId
in: query
schema:
type: string
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the file list received successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/FileDeleteResponse'
'204':
description: Indicates that the file list not found.
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
invalid logged user or company.'
operationId: getApiV21FileByUniqueId
x-operation-id-source: derived
/api/v2.1/File/device-telemetry/{uniqueId}:
get:
tags:
- File
summary: Get device telemetry file url(s)
description: This API endpoint allows you to download device telemetry file from the cloud. For that, you need to send uniqueId in request url.
parameters:
- name: uniqueId
in: path
description: device uniqueId
required: true
schema:
type: string
- name: imageViewer
in: query
description: Image Viewer
schema:
type: boolean
- name: fileGuid
in: query
schema:
type: string
format: uuid
- name: pageSize
in: query
schema:
type: integer
format: int32
- name: pageNumber
in: query
schema:
type: integer
format: int32
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the device telemetry file received successfully.
'204':
description: Indicates that the file not found.
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
device not found, invalid logged user or company.'
operationId: getApiV21FileDeviceTelemetryByUniqueId
x-operation-id-source: derived
/api/v2.1/File/bulk:
post:
tags:
- File
summary: Upload multiple files
description: This API endpoint allows you to upload multiple files on the cloud. You can upload different files like user profile, device image, firmware file etc. For that, you need to send ModuleType, defining the type of file. The fileRefGuid is a reference guid, saying a file belongs to which module. For example, for a user profile, it requires a user guid to define that to which user the file belongs.
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the file uploaded successfully and returns files details.
content:
application/json:
schema:
$ref: '#/components/schemas/BulkFileAddResponse'
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
invalid logged user or company.'
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
fileRefGuid:
type: string
format: uuid
description: "Reference Guid. \n Eg.- deviceGuid for deviceimage
- companyGuid for companylogo
- firmwareUpgradeGuid for firmware
- userGuid for userprofile
- importBatchGuid for importbatch
- solutionGuid for solutionimage
- deviceCertificateGuid for devicecertificate
- any guid for custom
- moduleGuid for module
- dashboardWidgetGuid for widgetimage
- dashboardBackgroundGuid for dashboardimage
"
Tag:
type: string
description: Tag of file
ModuleType:
type: string
description: "Module type should be one of below items \n- deviceimage
- companylogo
- firmware
- userprofile
- importbatch
- solutionimage
- devicecertificate
- custom
- module
- widgetimage
- deviceupdate
- ggComponentArtifact
- ggComponentRecipe
"
fileDatas:
type: array
description: Upload new files
CompanyGuid:
type: string
format: uuid
description: Company Guid.
IsCpidOptional:
type: boolean
required:
- fileRefGuid
- ModuleType
- fileDatas
operationId: postApiV21FileBulk
x-operation-id-source: derived
/api/v2.1/File/artifactFile:
post:
tags:
- File
summary: Upload a file
description: This API endpoint allows you to upload files on the cloud. You can upload different files like user profile, device image, firmware file etc. For that, you need to send ModuleType, defining the type of file. The fileRefGuid is a reference guid, saying a file belongs to which module. For example, for a user profile, it requires a user guid to define that to which user the file belongs.
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the file uploaded successfully and returns file details.
content:
application/json:
schema:
$ref: '#/components/schemas/FileAddResponse'
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
invalid logged user or company.'
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
ChunkFiles:
type: array
RecipeGuid:
type: string
format: uuid
ModuleType:
type: string
description: "Module type should be one of below items \n- deviceimage
- companylogo
- firmware
- userprofile
- importbatch
- solutionimage
- devicecertificate
- custom
- module
- widgetimage
- deviceupdate
- ggComponentArtifact
- ggComponentRecipe
"
fileData:
type: string
description: Upload new file
format: binary
InValidFileName:
type: string
operationId: postApiV21FileArtifactFile
x-operation-id-source: derived
/api/v2.1/File/componentBulk:
post:
tags:
- File
summary: Upload multiple component files
description: This API endpoint allows you to upload multiple files on the cloud. You can upload different files like user profile, device image, firmware file etc. For that, you need to send ModuleType, defining the type of file. The fileRefGuid is a reference guid, saying a file belongs to which module. For example, for a user profile, it requires a user guid to define that to which user the file belongs.
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the file uploaded successfully and returns files details.
content:
application/json:
schema:
$ref: '#/components/schemas/BulkFileAddResponse'
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
invalid logged user or company.'
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
fileRefGuid:
type: string
format: uuid
description: "Reference Guid. \n Eg.- deviceGuid for deviceimage
- companyGuid for companylogo
- firmwareUpgradeGuid for firmware
- userGuid for userprofile
- importBatchGuid for importbatch
- solutionGuid for solutionimage
- deviceCertificateGuid for devicecertificate
- any guid for custom
- moduleGuid for module
- dashboardWidgetGuid for widgetimage
- dashboardBackgroundGuid for dashboardimage
"
ModuleType:
type: string
description: "Module type should be one of below items \n- deviceimage
- companylogo
- firmware
- userprofile
- importbatch
- solutionimage
- devicecertificate
- custom
- module
- widgetimage
- deviceupdate
- ggComponentArtifact
- ggComponentRecipe
"
ArtifactFileNames:
type: array
description: Upload new files
RecipeGuid:
type: string
format: uuid
FileData:
type: string
description: Upload new file
format: binary
Tag:
type: string
description: Tag of file
CompanyGuid:
type: string
format: uuid
description: Company Guid.
IsCpidOptional:
type: boolean
required:
- fileRefGuid
- ModuleType
- ArtifactFileNames
- RecipeGuid
- FileData
operationId: postApiV21FileComponentBulk
x-operation-id-source: derived
/api/v2.1/File/verifyReceipeFile:
post:
tags:
- File
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: OK
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
file:
type: string
format: binary
artifactFiles:
type: array
ModuleType:
type: string
description: "Module type should be one of below items \n- deviceimage
- companylogo
- firmware
- userprofile
- importbatch
- solutionimage
- devicecertificate
- custom
- module
- widgetimage
- deviceupdate
- ggComponentArtifact
- ggComponentRecipe
- sagemakerModule
"
fileData:
type: string
description: Upload new file
format: binary
CompanyGuid:
type: string
format: uuid
description: Company Guid.
required:
- ModuleType
summary: Create api file verify receipe file
x-summary-source: derived
operationId: postApiV21FileVerifyReceipeFile
x-operation-id-source: derived
/api/v2.1/File/artifactFileDelete:
post:
tags:
- File
summary: Delete artifact file
description: This API endpoint permits you to delete artifact file from the cloud. For that, you need to send modelType and fileGuid in request url.
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the file deleted successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/FileDeleteResponse'
'204':
description: Indicates that the file not found.
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
invalid logged user or company.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/ArtifactFileDeleteRequest'
operationId: postApiV21FileArtifactFileDelete
x-operation-id-source: derived
/api/v2.1/File/presigned-url:
post:
tags:
- File
summary: Generate Pre-Signed URL
description: This API endpoint allows you to generate pre-signed url.
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the pre signed url generated.
content:
application/json:
schema:
$ref: '#/components/schemas/PreSignedURLResponse'
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
invalid logged user or company.'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PreSignedURLRequest'
description: Json object
operationId: postApiV21FilePresignedUrl
x-operation-id-source: derived
/api/v2.1/File/recipe:
post:
tags:
- File
summary: Upload a Greengrass recipe file
description: This API endpoint allows you to upload files on the cloud.
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the file uploaded successfully and returns file details.
content:
application/json:
schema:
$ref: '#/components/schemas/FileAddResponse'
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
invalid logged user or company.'
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
RecipeFile:
type: string
format: binary
required:
- RecipeFile
operationId: postApiV21FileRecipe
x-operation-id-source: derived
/api/v2.1/File/removeArtifactFileFromReceipe:
post:
tags:
- File
summary: Remove artifact file from recipe file
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the RemoveArtifactFile request completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveArtifactFileResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RemoveArtifactFileRequest'
description: The request object
operationId: postApiV21FileRemoveArtifactFileFromReceipe
x-operation-id-source: derived
/api/v2.1/File/chunk/{moduleType}/initiate:
post:
tags:
- File
summary: Initiates a new file upload process
parameters:
- name: moduleType
in: path
required: true
schema:
type: string
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Returns the upload initiation response.
content:
application/json:
schema:
$ref: '#/components/schemas/UploadInitResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/UploadInitRequest'
description: The upload initialization request containing metadata like file name, content type, etc.
operationId: postApiV21FileChunkByModuleTypeInitiate
x-operation-id-source: derived
/api/v2.1/File/chunk/{moduleType}/urls:
post:
tags:
- File
summary: Retrieves pre-signed URLs for multipart upload
parameters:
- name: moduleType
in: path
required: true
schema:
type: string
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Returns the pre-signed URL response.
content:
application/json:
schema:
$ref: '#/components/schemas/PresignedUrlsResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/PresignedUrlsRequest'
description: The request containing upload ID and part count.
operationId: postApiV21FileChunkByModuleTypeUrls
x-operation-id-source: derived
/api/v2.1/File/chunk/complete/{moduleType}:
put:
tags:
- File
summary: Completes the multipart upload process
parameters:
- name: moduleType
in: path
required: true
schema:
type: string
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Returns the complete upload response.
content:
application/json:
schema:
$ref: '#/components/schemas/CompleteUploadResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/CompleteUploadRequest'
description: The request containing upload ID, key name, and part information.
operationId: putApiV21FileChunkCompleteByModuleType
x-operation-id-source: derived
/api/v2.1/File/retryFileAccess:
post:
tags:
- File
summary: Retry file access for a given recipe and artifact file name
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the RetryFileAccess request completed successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/RetryFileAccessResponse'
requestBody:
content:
application/json:
schema:
$ref: '#/components/schemas/RetryFileAccessRequest'
description: The request object
operationId: postApiV21FileRetryFileAccess
x-operation-id-source: derived
/api/v1.1/File:
post:
tags:
- File
summary: Upload a file
description: This API endpoint allows you to upload files on the cloud. You can upload different files like user profile, device image, firmware file etc. For that, you need to send ModuleType, defining the type of file. The fileRefGuid is a reference guid, saying a file belongs to which module. For example, for a user profile, it requires a user guid to define that to which user the file belongs.
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the file uploaded successfully and returns file details.
content:
application/json:
schema:
$ref: '#/components/schemas/FileAddResponse'
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
invalid logged user or company.'
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
fileRefGuid:
type: string
format: uuid
description: "Reference Guid. \n Eg.- deviceGuid for deviceimage
- companyGuid for companylogo
- firmwareUpgradeGuid for firmware
- userGuid for userprofile
- importBatchGuid for importbatch
- solutionGuid for solutionimage
- deviceCertificateGuid for devicecertificate
- any guid for custom
- moduleGuid for module
- dashboardWidgetGuid for widgetimage
- dashboardBackgroundGuid for dashboardimage
"
Tag:
type: string
description: Tag of file
ModuleType:
type: string
description: "Module type should be one of below items \n- deviceimage
- companylogo
- firmware
- userprofile
- importbatch
- solutionimage
- devicecertificate
- custom
- module
- widgetimage
- deviceupdate
"
FileData:
type: string
description: Upload new file
format: binary
CompanyGuid:
type: string
format: uuid
description: Company Guid.
IsSphere:
type: boolean
required:
- fileRefGuid
- ModuleType
- FileData
operationId: postApiV11File
x-operation-id-source: derived
/api/v1.1/File/{fileGuid}:
put:
tags:
- File
summary: Update File by file guid
description: This API endpoint lets you update a file on the cloud. For that, you need to send fileGuid in request url and updated file in the request body.
parameters:
- name: fileGuid
in: path
description: File Guid
required: true
schema:
type: string
format: uuid
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the file updated successfully and returns updated file details.
content:
application/json:
schema:
$ref: '#/components/schemas/FileUpdateResponse'
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
invalid logged user or company.'
requestBody:
content:
multipart/form-data:
schema:
type: object
properties:
ModuleType:
type: string
description: "Module type should be one of below items \n- deviceimage
- companylogo
- firmware
- userprofile
- importbatch
- solutionimage
- devicecertificate
- custom
- module
- widgetimage
- deviceupdate
"
FileData:
type: string
description: Upload new file
format: binary
CompanyGuid:
type: string
format: uuid
description: Company Guid.
IsSphere:
type: boolean
required:
- ModuleType
- FileData
operationId: putApiV11FileByFileGuid
x-operation-id-source: derived
/api/v1.1/File/{moduleType}/{fileGuid}:
delete:
tags:
- File
summary: Delete a file
description: This API endpoint permits you to delete a file from the cloud. For that, you need to send modelType and fileGuid in request url.
parameters:
- name: moduleType
in: path
description: 'Module type should be one of below items
- deviceimage
- companylogo
- firmware
- userprofile
- importbatch
- solutionimage
- devicecertificate
- custom
- module
- widgetimage
'
required: true
schema:
type: string
- name: fileGuid
in: path
description: File Guid
required: true
schema:
type: string
format: uuid
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the file deleted successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/FileDeleteResponse'
'204':
description: Indicates that the file not found.
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
invalid logged user or company.'
operationId: deleteApiV11FileByModuleTypeByFileGuid
x-operation-id-source: derived
/api/v1.1/File/{moduleType}/{fileRefGuid}:
get:
tags:
- File
summary: Get file list
description: This API endpoint allows you to download files from the cloud. For that, you need to send moduleType and fileRefGuid in request url.
parameters:
- name: moduleType
in: path
description: 'Module type should be one of below items
- deviceimage
- companylogo
- firmware
- userprofile
- importbatch
- solutionimage
- devicecertificate
- custom
- module
- widgetimage
'
required: true
schema:
type: string
- name: fileRefGuid
in: path
description: Reference Guid.Eg.
required: true
schema:
type: string
format: uuid
- name: isSphere
in: query
description: Is Sphere to get sphere firmware file list.Eg.- deviceGuid for deviceimage
- companyGuid for companylogo
- firmwareUpgradeGuid for firmware
- userGuid for userprofile
- importBatchGuid for importbatch
- solutionGuid for solutionimage
- deviceCertificateGuid for devicecertificate
- any guid for custom
- moduleGuid for module
- dashboardWidgetGuid for widgetimage
schema:
type: boolean
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the file list received successfully.
content:
application/json:
schema:
$ref: '#/components/schemas/FileDeleteResponse'
'204':
description: Indicates that the file list not found.
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
invalid logged user or company.'
operationId: getApiV11FileByModuleTypeByFileRefGuid
x-operation-id-source: derived
/api/v1.1/File/device-telemetry/{uniqueId}:
get:
tags:
- File
summary: Get device telemetry file url(s)
description: This API endpoint allows you to download device telemetry file from the cloud. For that, you need to send uniqueId in request url.
parameters:
- name: uniqueId
in: path
description: device uniqueId
required: true
schema:
type: string
- name: imageViewer
in: query
description: Image Viewer
schema:
type: boolean
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the device telemetry file received successfully.
'204':
description: Indicates that the file not found.
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
device not found, invalid logged user or company.'
operationId: getApiV11FileDeviceTelemetryByUniqueId
x-operation-id-source: derived
/api/v1.1/File/bulk:
post:
tags:
- File
summary: Upload multiple files
description: This API endpoint allows you to upload multiple files on the cloud. You can upload different files like user profile, device image, firmware file etc. For that, you need to send ModuleType, defining the type of file. The fileRefGuid is a reference guid, saying a file belongs to which module. For example, for a user profile, it requires a user guid to define that to which user the file belongs.
responses:
'412':
description: Indicates that a condition set for this request is failed, and the request cannot be carried out.
'401':
description: Indicates that authentication is failed because of the token is invalid or expired or missing.
'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/ErrorsResponse'
'200':
description: Indicates that the file uploaded successfully and returns files details.
content:
application/json:
schema:
$ref: '#/components/schemas/BulkFileAddResponse'
'409':
description: 'Indicates that the request could not be carried out because of one of the below or other conflicts on the server.
invalid logged user or company.'
requestBody:
content:
application/x-www-form-urlencoded:
schema:
type: object
properties:
fileRefGuid:
type: string
format: uuid
description: "Reference Guid. \n Eg.- deviceGuid for deviceimage
- companyGuid for companylogo
- firmwareUpgradeGuid for firmware
- userGuid for userprofile
- importBatchGuid for importbatch
- solutionGuid for solutionimage
- deviceCertificateGuid for devicecertificate
- any guid for custom
- moduleGuid for module
- dashboardWidgetGuid for widgetimage
- dashboardBackgroundGuid for dashboardimage
"
Tag:
type: string
description: Tag of file
ModuleType:
type: string
description: "Module type should be one of below items \n- deviceimage
- companylogo
- firmware
- userprofile
- importbatch
- solutionimage
- devicecertificate
- custom
- module
- widgetimage
- deviceupdate
"
fileDatas:
type: array
description: Upload new files
CompanyGuid:
type: string
format: uuid
description: Company Guid.
required:
- fileRefGuid
- ModuleType
- fileDatas
operationId: postApiV11FileBulk
x-operation-id-source: derived
components:
schemas:
RetryFileAccessRequest:
type: object
properties:
recipeGuid:
type: string
format: uuid
filePath:
type:
- string
- 'null'
additionalProperties: false
PreSignedURLRequest:
required:
- fileRefGuid
- moduleType
type: object
properties:
tag:
type:
- string
- 'null'
fileName:
type:
- string
- 'null'
fileRefGuid:
type: string
description: "Reference Guid. \n Eg.- deviceGuid for deviceimage
- companyGuid for companylogo
- firmwareUpgradeGuid for firmware
- userGuid for userprofile
- importBatchGuid for importbatch
- solutionGuid for solutionimage
- deviceCertificateGuid for devicecertificate
- any guid for custom
- moduleGuid for module
- dashboardWidgetGuid for widgetimage
- dashboardBackgroundGuid for dashboardimage
"
format: uuid
moduleType:
minLength: 1
type: string
description: "Module type should be one of below items \n- deviceimage
- companylogo
- firmware
- userprofile
- importbatch
- solutionimage
- devicecertificate
- custom
- module
- widgetimage
- deviceupdate
- ggComponentArtifact
- ggComponentRecipe
"
additionalProperties: false
RemoveArtifactFileResponse:
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
CompleteUploadResponse:
type: object
properties:
data:
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
ErrorModel:
type: object
properties:
param:
type:
- string
- 'null'
message:
type:
- string
- 'null'
additionalProperties: false
CompleteUploadRequest:
type: object
properties:
fileName:
type:
- string
- 'null'
uploadId:
type:
- string
- 'null'
parts:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PartETagDto'
additionalProperties: false
PresignedUrlsRequest:
type: object
properties:
fileName:
type:
- string
- 'null'
uploadId:
type:
- string
- 'null'
partsCount:
type: integer
format: int32
additionalProperties: false
PartETagDto:
type: object
properties:
partNumber:
type: integer
format: int32
eTag:
type:
- string
- 'null'
additionalProperties: false
RemoveArtifactFileRequest:
type: object
properties:
recipeGuid:
type: string
format: uuid
artifactFileName:
type:
- string
- 'null'
additionalProperties: false
BulkFileAddResponse:
type: object
properties:
data:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/FileDetail'
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
PresignedUrlsResponse:
type: object
properties:
data:
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
FileDetail:
type: object
properties:
tag:
type:
- string
- 'null'
operationId:
type:
- string
- 'null'
format: uuid
componentName:
type:
- string
- 'null'
componentVersion:
type:
- string
- 'null'
guid:
type:
- string
- 'null'
file:
type:
- string
- 'null'
name:
type:
- string
- 'null'
fileDetails:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/UrlCheckResult'
additionalProperties: false
FileBaseDetail:
type: object
properties:
guid:
type:
- string
- 'null'
file:
type:
- string
- 'null'
name:
type:
- string
- 'null'
fileDetails:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/UrlCheckResult'
additionalProperties: false
RetryFileAccessResponse:
type: object
properties:
data:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/RetryFileAccess'
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
RetryFileAccess:
type: object
properties:
recipeGuid:
type: string
format: uuid
url:
type:
- string
- 'null'
isAccessible:
type: boolean
status:
type:
- string
- 'null'
additionalProperties: false
FileUpdateResponse:
type: object
properties:
data:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/FileBaseDetail'
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
ErrorsResponse:
type: object
properties:
status:
type: integer
format: int32
message:
type:
- string
- 'null'
error:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/ErrorModel'
additionalProperties: false
UrlCheckResult:
type: object
properties:
url:
type:
- string
- 'null'
isAccessible:
type: boolean
status:
type:
- string
- 'null'
additionalProperties: false
UploadInitRequest:
type: object
properties:
fileName:
type:
- string
- 'null'
additionalProperties: false
UploadInitResponse:
type: object
properties:
data:
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
FileDeleteResponse:
type: object
properties:
data:
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
PreSignedURLResponse:
type: object
properties:
data:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/PreSignedURLDetail'
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
ArtifactFileDeleteRequest:
required:
- artifactFileNames
type: object
properties:
artifactFileNames:
type: array
items:
type: string
recipeGuid:
type: string
format: uuid
additionalProperties: false
PreSignedURLDetail:
type: object
properties:
guid:
type:
- string
- 'null'
file:
type:
- string
- 'null'
preSignedURL:
type:
- string
- 'null'
name:
type:
- string
- 'null'
tag:
type:
- string
- 'null'
additionalProperties: false
FileAddResponse:
type: object
properties:
data:
type:
- array
- 'null'
items:
$ref: '#/components/schemas/FileDetail'
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
FileDetail_2:
type: object
properties:
tag:
type:
- string
- 'null'
operationId:
type:
- string
- 'null'
format: uuid
guid:
type:
- string
- 'null'
file:
type:
- string
- 'null'
name:
type:
- string
- 'null'
additionalProperties: false
FileBaseDetail_2:
type: object
properties:
guid:
type:
- string
- 'null'
file:
type:
- string
- 'null'
name:
type:
- string
- 'null'
additionalProperties: false
securitySchemes:
Bearer:
type: apiKey
description: Please enter JWT with Bearer into field
name: Authorization
in: header
x-refined-from:
- avnet-iotconnect-file-aws-prod-swagger.json
- avnet-iotconnect-file-azure-prod-swagger.json