Skip to main content

Files

API docs by Redocly

SAM: Files (1.0.0)

Download OpenAPI specification:Download

URL: https://www.flexera.com

API for managing SAM files.

Files

Get file

Returns the details of the given file.

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>

The unique ID of the file.

Responses

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "fileName": "file.txt",
  • "fileTitle": "file title",
  • "description": "Document needed for OS installation",
  • "assetId": "123e4567-e89b-12d3-a456-426614174000",
  • "assetTypeId": "56133D81-BBDB-4BDC-A4D1-4E64CA494D08",
  • "assetOrgId": "56133D81-BBDB-4BDC-A4D1-4E64CA494D08",
  • "insertedTs": "2025-04-24T18:43:03Z",
  • "modifiedTs": "2025-04-24T18:43:03Z"
}

Replace file metadata

Replaces file's metadata.

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>

The unique ID of the file.

Request Body schema: application/json
fileTitle
string

The title for the file.

description
string

The file description.

Responses

Request samples

Content type
application/json
{
  • "fileTitle": "A title",
  • "description": "Document needed for OS installation"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "fileName": "file.txt",
  • "fileTitle": "file title",
  • "description": "Document needed for OS installation",
  • "assetId": "123e4567-e89b-12d3-a456-426614174000",
  • "assetTypeId": "56133D81-BBDB-4BDC-A4D1-4E64CA494D08",
  • "assetOrgId": "56133D81-BBDB-4BDC-A4D1-4E64CA494D08",
  • "insertedTs": "2025-04-24T18:43:03Z",
  • "modifiedTs": "2025-04-24T18:43:03Z"
}

Add file

Creates a single file for an asset.

Authorizations:
BearerAuth
Request Body schema: application/json
fileTitle
required
string

The file title. Optional.

description
required
string

The file description.

fileName
required
string

The file name with extension separated by a dot.

assetId
required
string <uuid>

The unique ID of the asset.

assetTypeId
required
string <uuid>

The unique ID of the asset type.

fileType
string

The file type.

Responses

Request samples

Content type
application/json
{
  • "fileTitle": "file title",
  • "description": "Document needed for OS installation",
  • "fileName": "file.txt",
  • "assetId": "123e4567-e89b-12d3-a456-426614174000",
  • "assetTypeId": "56133D81-BBDB-4BDC-A4D1-4E64CA494D08",
  • "fileType": "application/pdf"
}

Response samples

Content type
application/json
{
  • "id": "123e4567-e89b-12d3-a456-426614174000",
  • "fileTitle": "file title",
  • "status": "UploadInProgress",
  • "description": "Document needed for OS installation",
  • "fileName": "file.txt",
  • "assetId": "123e4567-e89b-12d3-a456-426614174000",
  • "assetTypeId": "56133D81-BBDB-4BDC-A4D1-4E64CA494D08",
  • "assetOrgId": "56133D81-BBDB-4BDC-A4D1-4E64CA494D08",
  • "insertedTs": "2025-04-24T18:43:03Z",
  • "modifiedTs": "2025-04-24T18:43:03Z"
}

Delete file

Removes the given file.

Authorizations:
BearerAuth
path Parameters
id
required
string <uuid>

The unique ID of the file.

Responses

Response samples

Content type
application/json
{
  • "error": {
    }
}

Files collection

Get asset files

Returns a collection of files for the given asset.

Authorizations:
BearerAuth
path Parameters
assetId
required
string <uuid>

The unique ID of the asset.

query Parameters
page_size
integer
Default: 100

The maximum number of items in the response.

page_number
integer <int64>
Default: 1

The page number.

filter
string

For more information on the available operators and which data types those operators work on, see Filter API call results.

sort
string

For more information on sorting capability and examples, see Sort API call results.

Responses

Response samples

Content type
application/json
{
  • "items": [
    ],
  • "pagination": {
    }
}