---
title: "Asset link types REST services"
canonical: "https://support.appfire.com/space/AIP/10256915/Asset%20link%20types%20REST%20services"
format: markdown
---
> Macro (aura-html)

This document describes the REST API for managing Asset Link Types within the Assets & Inventory Plugin system.

## Listing all asset link types

| **Method** | GET |
| --- | --- |
| **URL** | /rest/jip-api/1.0/asset-link-type.json |

<details>
<summary>Sample response:</summary>

```
{
  "success" : true,
  "errorCode" : null,
  "errorMessage" : null,
  "data" : [ {
    "id" : 3,
    "assetLinkName" : "Connects",
    "outwardDescription" : "connects",
    "inwardDescription" : "connected by"
  }, {
    "id" : 2,
    "assetLinkName" : "Has",
    "outwardDescription" : "has",
    "inwardDescription" : "has by"
  }, {
    "id" : 5,
    "assetLinkName" : "Install",
    "outwardDescription" : "installs",
    "inwardDescription" : "installed to"
  }, {
    "id" : 4,
    "assetLinkName" : "Own",
    "outwardDescription" : "owns",
    "inwardDescription" : "owned by"
  }, {
    "id" : 1,
    "assetLinkName" : "Use",
    "outwardDescription" : "uses",
    "inwardDescription" : "used by"
  }, {
    "id" : 6,
    "assetLinkName" : "Work",
    "outwardDescription" : "works",
    "inwardDescription" : "works at"
  } ],
  "pagingInfo" : null
}
```
</details>

## Listing single asset link type

| **Method** | GET |
| --- | --- |
| **URL** | /rest/jip-api/1.0/asset-link-type/[assetLinkTypeId].json |

<details>
<summary>Sample response:</summary>

```
{
  "success" : true,
  "errorCode" : null,
  "errorMessage" : null,
  "data" : {
    "id" : 3,
    "assetLinkName" : "Connects",
    "outwardDescription" : "connects",
    "inwardDescription" : "connected by"
  },
  "pagingInfo" : null
}
```
</details>

<details>
<summary>Failure message:</summary>

```
{
  "success" : true,
  "errorCode" : null,
  "errorMessage" : null,
  "data" : {
    "id" : null,
    "assetLinkName" : null,
    "outwardDescription" : null,
    "inwardDescription" : null
  },
  "pagingInfo" : null
}
```
</details>

## Creating a new asset link type

| **Method** | POST |
| --- | --- |
| **URL** | /rest/jip-api/1.0/asset-link-type.json |

<details>
<summary>Request body:</summary>

```
{
  "assetLinkName": "Duplicate",
  "id": null,
  "inwardDescription": "duplicated by",
  "outwardDescription": "duplicates"
}
```
</details>

<details>
<summary>Sample response:</summary>

```
{
  "success" : true,
  "errorCode" : null,
  "errorMessage" : null,
  "data" : {
    "id" : 16,
    "assetLinkName" : "Duplicate",
    "outwardDescription" : "duplicates",
    "inwardDescription" : "duplicated by"
  },
  "pagingInfo" : null
}
```
</details>

<details>
<summary>Failure message:</summary>

```
{
  "success": false,
  "errorCode": "EntityExistsException",
  "errorMessage": "Duplicate",
  "data": null,
  "pagingInfo": null
}
```
</details>

## Update asset link type

| **Method** | POST |
| --- | --- |
| **URL** | /rest/jip-api/1.0/asset-link-type.json |

<details>
<summary>Request body:</summary>

```
{
"assetLinkName": "Duplicate",
"id": 16,
"inwardDescription": "duplicated by",
"outwardDescription": "duplicates"
}
```
</details>

<details>
<summary>Sample response:</summary>

```
{
  "success" : true,
  "errorCode" : null,
  "errorMessage" : null,
  "data" : {
    "id" : 16,
    "assetLinkName" : "Duplicate",
    "outwardDescription" : "duplicates",
    "inwardDescription" : "duplicated by"
  },
  "pagingInfo" : null
}
```
</details>

<details>
<summary>Failure message:</summary>

```
{
  "success": false,
  "errorCode": "EntityNotFoundException",
  "errorMessage": "Asset link type not found. ID: 123",
  "data": null,
  "pagingInfo": null
}
```
</details>

## Delete asset link type

| **Method** | DELETE |
| --- | --- |
| **URL** | /rest/jip-api/1.0/asset-link-type/[assetLinkTypeId].json |

<details>
<summary>Sample request:</summary>

```
{
  "success" : true,
  "errorCode" : null,
  "errorMessage" : null,
  "data" : true,
  "pagingInfo" : null
}
```
</details>

<details>
<summary>Failure message:</summary>

```
{
  "success" : false,
  "errorCode" : "EntityNotFoundException",
  "errorMessage" : "Asset Link Type id: 25",
  "data" : null,
  "pagingInfo" : null
}
```
</details>