SAM: Links (1.0.0)

Download OpenAPI specification:Download

URL: https://www.flexera.com

API for interacting with SAM links.

Links

Get link details

Returns the details of a link.

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid>

The unique ID of the link.

Responses

Response samples

200
400
404
500

Content type

application/json

{"id": "a8411272-aa0d-42f3-823f-0fb1ceee16c0",
"description": "Document needed for OS installation",
"url": "https://somedomain.com/file.txt",
"createdDate": "2024-08-12T05:04:34Z",
"lastUpdatedDate": "2024-09-12T07:09:34Z",
"assetType": {"id": "56133D81-BBDB-4BDC-A4D1-4E64CA494D08",
"name": "License"
}
}

Replace a single link

Replaces an asset's link with the one provided.

Authorizations:

BearerAuth

path Parameters

id

required

string <uuid>

The unique ID of the link.

Request Body schema: application/json

url required	string The URL which points to a specific resource.
description	string The link description.

Responses

Request samples

Payload

Content type

application/json

{"url": "https://somedomain.com",
"description": "Document needed for OS installation"
}

Response samples

200
400
404
500

Content type

application/json

{"id": "a8411272-aa0d-42f3-823f-0fb1ceee16c0",
"description": "Document needed for OS installation",
"url": "https://somedomain.com/file.txt",
"createdDate": "2024-08-12T05:04:34Z",
"lastUpdatedDate": "2024-09-12T07:09:34Z",
"assetType": {"id": "56133D81-BBDB-4BDC-A4D1-4E64CA494D08",
"name": "License"
}
}

Add a single link

Creates a single link for asset.

Authorizations:

BearerAuth

Request Body schema: application/json

assetId required	string <uuid> The unique ID of the asset.
assetTypeId required	string <uuid> The unique ID of the asset type.
url required	string The URL which points to a specific resource.
description	string The link description.

Responses

Request samples

Payload

Content type

application/json

{"assetId": "123e4567-e89b-12d3-a456-426614174000",
"assetTypeId": "56133D81-BBDB-4BDC-A4D1-4E64CA494D08",
"url": "https://somedomain.com/file.txt",
"description": "Document needed for OS installation"
}

Response samples

201
400
500

Content type

application/json

{"id": "a8411272-aa0d-42f3-823f-0fb1ceee16c0",
"description": "Document needed for OS installation",
"url": "https://somedomain.com/file.txt",
"createdDate": "2024-08-12T05:04:34Z",
"lastUpdatedDate": "2024-09-12T07:09:34Z",
"assetType": {"id": "56133D81-BBDB-4BDC-A4D1-4E64CA494D08",
"name": "License"
}
}

Links collection

Get links for asset

Returns a collection of links for an asset.

Authorizations:

BearerAuth

path Parameters

assetId

required

string <uuid>

The unique ID of the asset.

query Parameters

page_size	integer <= 1000 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

200
400
404
500

Content type

application/json

{"items": [{"id": "a8411272-aa0d-42f3-823f-0fb1ceee16c0",
"description": "Document needed for OS installation",
"url": "https://somedomain.com/file.txt",
"createdDate": "2024-08-12T05:04:34Z",
"lastUpdatedDate": "2024-09-12T07:09:34Z",
"assetType": {"id": "56133D81-BBDB-4BDC-A4D1-4E64CA494D08",
"name": "License"
}
}
],
"pagination": {"page_size": 25,
"page_number": 1,
"total_pages": 5,
"total_items": 100
}
}

Bulk delete links

Removes a collection of links. This operation cannot be undone.

Authorizations:

BearerAuth

Request Body schema: application/json

ids

required

Array of strings <uuid> [ items <uuid > ]

The list of link identifiers.

Responses

Request samples

Payload

Content type

application/json

{"ids": {"0": "a8411272-aa0d-42f3-823f-0fb1ceee14b7",
"1": "a8411272-aa0d-42f3-823f-0fb1ceee14b9"
}
}

Response samples

200
400
500

Content type

application/json

{"ids": {"0": "a8411272-aa0d-42f3-823f-0fb1ceee14b7",
"1": "a8411272-aa0d-42f3-823f-0fb1ceee14b9"
}
}