Index

api/v1/assets

Path: api/v1/assets

This API is JSON:API compliant.

This endpoint supports the following methods:
GET POST PATCH

The resource type for this endpoint is Asset
The identifier is assetno

The Asset resource type attributes are as follows:

{
"assetCode":string
"priority":string
"status":string
"custRef":string
"reqDays":
"reqHours":
"serialNo":string
"dateIn":string
"dateOut":string
"warDateIn":string
"warDateOut":string
"shipInfo":string
"useShipAddr":boolean
"shipComment":string
"itemDesc":string
"attn":string
"requestByName":string (read-only)
"comment":string
"companyCode":string (read-only)
"BranchCode":string
"SubBranchCode":string
"GLDeptCode":string
optional
"eKMRequestThresholdOverrideNo":integer
"eKMStatusCode":string
"costCentre":string
optional
"costValue":number
"groups": [{
"type":string
"id":integer
"name":string
}]
}

Example GET (Return specific)

Path: api/v1/assets/10

Response:

{
  "data": {
    "id": "10",
    "type": "Asset",
    "attributes": {
      "assetCode": "MCH.C3",
      "priority": "Normal",
      "status": "Booked",
      "custRef": "",
      "reqDays": null,
      "reqHours": null,
      "serialNo": "7-1234ABC-MCHC3",
      "dateIn": "2025-10-03",
      "dateOut": null,
      "warDateIn": null,
      "warDateOut": null,
      "shipInfo": "Simple cust #1\r\nSimple Cust Address\r\nAARONS PASS NSW 2850",
      "useShipAddr": false,
      "shipComment": null,
      "itemDesc": "MultiFunction Centre Type 2",
      "attn": null,
      "requestByName": null,
      "comment": null,
      "companyCode": null,
      "BranchCode": null,
      "SubBranchCode": null,
      "GLDeptCode": null,
      "eKMRequestThresholdOverrideNo": null,
      "eKMStatusCode": null,
      "costCentre": null,
      "costValue": null,
      "groups": []
    },
    "relationships": {
      "owner": {
        "data": {
          "type": "CardFile",
          "id": "6"
        }
      },
      "ship": {
        "data": {
          "type": "CardFile",
          "id": "6"
        }
      },
      "item": {
        "data": {
          "type": "Item",
          "id": "6"
        }
      }
    },
    "links": { "self": "/jim_initialtest/api/v1/asset/10" }
  }
}

Example POST

Path: api/v1/assets

Request:

{
  "data": {
    "type": "Asset",
    "attributes": {
      "Priority": "Normal",
      "SerialNo": "123456ABCD",
      "ReqDays": "10",
      "ReqHours": "2",
      "CustRef": "AssetCustRef"
    },
    "relationships": {
      "owner": {
        "data": {
          "type": "CardFile",
          "id": "1"
        }
      },
      "ship": {
        "data": {
          "type": "CardFile",
          "id": "2"
        }
      },
      "item": {
        "data": {
          "type": "Item",
          "id": "1"
        }
      },
      "accountManager": {
        "data": {
          "type": "CardFile",
          "id": "16"
        }
      },
      "name": {
        "data": {
          "type": "CardFile",
          "id": "16"
        }
      }
    }
  }
}

Response:

{
  "data": {
    "id": "53",
    "type": "Asset",
    "attributes": {
      "assetCode": "53",
      "priority": "Normal",
      "status": "Booked",
      "custRef": "AssetCustRef",
      "reqDays": 10,
      "reqHours": 2,
      "serialNo": "123456ABCD",
      "dateIn": null,
      "dateOut": null,
      "warDateIn": null,
      "warDateOut": null,
      "shipInfo": null,
      "useShipAddr": false,
      "shipComment": null,
      "itemDesc": "Sale",
      "attn": null,
      "requestByName": null,
      "comment": null,
      "companyCode": null,
      "BranchCode": null,
      "SubBranchCode": null,
      "GLDeptCode": null,
      "eKMRequestThresholdOverrideNo": null,
      "eKMStatusCode": null,
      "costCentre": null,
      "costValue": null,
      "groups": []
    },
    "relationships": {
      "owner": {
        "data": {
          "type": "CardFile",
          "id": "1"
        }
      },
      "ship": {
        "data": {
          "type": "CardFile",
          "id": "2"
        }
      },
      "item": {
        "data": {
          "type": "Item",
          "id": "1"
        }
      },
      "name": {
        "data": {
          "type": "CardFile",
          "id": "16"
        }
      },
      "accountManager": {
        "data": {
          "type": "CardFile",
          "id": "16"
        }
      }
    },
    "links": { "self": "/jim_initialtest/api/v1/asset/1/53" }
  }
}

Example PATCH

Path: api/v1/assets/10

Request:

{
    "data": {
        "id":"1",
        "type": "Asset",
        "attributes": {
            "Status": "Booked",
            "CustRef": "NA",
            "Priority": "Normal",
            "DateIn": "2024-06-24"
        }
    }
}

Response:

{
  {
    "data": {
      "id": "1",
      "type": "Asset",
      "attributes": {
        "assetCode": "BCMB.1",
        "priority": "Normal",
        "status": "Booked",
        "custRef": "CONTRACT.SUB",
        "reqDays": null,
        "reqHours": null,
        "serialNo": "1234ABC-BCMB1",
        "dateIn": "2025-10-03",
        "dateOut": null,
        "warDateIn": null,
        "warDateOut": null,
        "shipInfo": "Simple cust #1\r\nSimple Cust Address\r\nAARONS PASS NSW 2850",
        "useShipAddr": false,
        "shipComment": null,
        "itemDesc": "MultiFunction Centre Type 2",
        "attn": "",
        "requestByName": "Email (Text)",
        "comment": null,
        "companyCode": null,
        "BranchCode": null,
        "SubBranchCode": null,
        "GLDeptCode": null,
        "eKMRequestThresholdOverrideNo": null,
        "eKMStatusCode": null,
        "costCentre": null,
        "costValue": null,
        "groups": []
      },
      "relationships": {
        "owner": {
          "data": {
            "type": "CardFile",
            "id": "6"
          }
        },
        "ship": {
          "data": {
            "type": "CardFile",
            "id": "6"
          }
        },
        "item": {
          "data": {
            "type": "Item",
            "id": "6"
          }
        },
        "name": {
          "data": {
            "type": "CardFile",
            "id": "16"
          }
        },
        "accountManager": {
          "data": {
            "type": "CardFile",
            "id": "16"
          }
        },
        "request": {
          "data": {
            "type": "CardFile",
            "id": "20"
          }
        }
      },
      "links": { "self": "/jim_initialtest/api/v1/asset/1" }
    }
  }
}

Generated from Jim2 version 4.6.9804.70