Page tree
Skip to end of metadata
Go to start of metadata

Listing all asset link types

MethodGET
URL/rest/jip-api/1.0/asset-link-type.json
Sample Response
{
  "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
}

Listing single asset link type

MethodGET
URL/rest/jip-api/1.0/asset-link-type/[assetLinkTypeId].json
Sample Response
{
  "success" : true,
  "errorCode" : null,
  "errorMessage" : null,
  "data" : {
    "id" : 3,
    "assetLinkName" : "Connects",
    "outwardDescription" : "connects",
    "inwardDescription" : "connected by"
  },
  "pagingInfo" : null
}
Failure Message
{
  "success" : true,
  "errorCode" : null,
  "errorMessage" : null,
  "data" : {
    "id" : null,
    "assetLinkName" : null,
    "outwardDescription" : null,
    "inwardDescription" : null
  },
  "pagingInfo" : null
}

Creating a new asset link type

MethodPOST
URL/rest/jip-api/1.0/asset-link-type.json
Request Body
{
  "assetLinkName": "Duplicate",
  "id": null,
  "inwardDescription": "duplicated by",
  "outwardDescription": "duplicates"
}
Sample Response
{
  "success" : true,
  "errorCode" : null,
  "errorMessage" : null,
  "data" : {
    "id" : 16,
    "assetLinkName" : "Duplicate",
    "outwardDescription" : "duplicates",
    "inwardDescription" : "duplicated by"
  },
  "pagingInfo" : null
}
Failure Message
{
  "success": false,
  "errorCode": "EntityExistsException",
  "errorMessage": "Duplicate",
  "data": null,
  "pagingInfo": null
}

Update asset link type

MethodPOST
URL/rest/jip-api/1.0/asset-link-type.json
Request Body
{
"assetLinkName": "Duplicate",
"id": 16,
"inwardDescription": "duplicated by",
"outwardDescription": "duplicates"
}
Sample Response
{
  "success" : true,
  "errorCode" : null,
  "errorMessage" : null,
  "data" : {
    "id" : 16,
    "assetLinkName" : "Duplicate",
    "outwardDescription" : "duplicates",
    "inwardDescription" : "duplicated by"
  },
  "pagingInfo" : null
}
Failure Message
{
  "success": false,
  "errorCode": "EntityNotFoundException",
  "errorMessage": "Asset link type not found. ID: 123",
  "data": null,
  "pagingInfo": null
}

Delete asset link type

MethodDELETE
URL/rest/jip-api/1.0/asset-link-type/[assetLinkTypeId].json
Sample Request
{
  "success" : true,
  "errorCode" : null,
  "errorMessage" : null,
  "data" : true,
  "pagingInfo" : null
}
Failure Message
{
  "success" : false,
  "errorCode" : "EntityNotFoundException",
  "errorMessage" : "Asset Link Type id: 25",
  "data" : null,
  "pagingInfo" : null
}
  • No labels