Asset Link

This is the API Documentation for the /api/asset-link/ route.

Retrieve ALL Asset Links

GET /api/asset-link/

Use this method to get ALL Asset Links from the Database.

200: OK AssetLink[]

Response will be an array of Asset Link objects.

Get ALL links by Hardware ID

GET /api/asset-link/hardware/:id/get-all

Path Parameters

Name	Type	Description
id*	String	The ID of the Asset

200: OK { hardware: HardwareAsset, link: AssetLink }

Response consists of both the Hardware Asset and the Asset Link.

404: Not Found

Get ALL links by Software ID

GET /api/asset-link/software/:id/get-all

Response consists of both an array with the Software Asset and the Asset Link.

Path Parameters

Name	Type	Description
id*	String	The ID of the Asset

200: OK { software: SoftwareAsset, link: AssetLink }

404: Not Found

Get ALL links by Software ID (excl. Software Asset)

GET /api/asset-link/software/:id

Response consists of both only the Asset Link array.

Path Parameters

Name	Type	Description
id*	String	The ID of the Asset

200: OK AssetLink[]

404: Not Found

Insert Asset Link

POST /api/asset-link/

You can use this method to insert an Asset Link into the Database.

Request Body

Name	Type	Description
hardware_id*	String	ID of the Hardware Asset you would like to be a part of the link.
software_id*	String	ID of the Software Asset you would like to be a part of the link.
date*	String	The Date the link was created
created_by*	String	The E-Mail Address of the Employee who creates the link.

400: Bad Request Body is not accurate to the specification above.

200: OK

Delete Asset Link

DELETE /api/asset-link/hardware/:hwid/:swid

Path Parameters

Name	Type	Description
hwid*	String	The ID of the Hardware Asset.
swid*	String	The ID of the Software Asset.

200: OK

404: Not Found