Documentation for AssetForms app REST API v1.0
To access AssetForms REST APIs you will need a token. Token can be generated via AssetForms app configuration
In "Manage apps" look for "AssetForms for Jira" and click "Configure" button
You will be presented with the configuration options available in AssetForms. Click on "API tokens" tab
Click on generate to generate new access token for the AssetForms REST API
Server URL is https://app.assetforms.com
API prefix /rest/api/v1
Method | URL endpoint | Request parameters | Errors | Example | |||
---|---|---|---|---|---|---|---|
Get asset type by ID or key | GET | /assettype/get/{token}/{assetTypeIdOrKey}
| 400 - When "assetTypeId" is missing 404 - When asset type cannot be found by given ID |
| |||
List asset types | GET | /assettype/list/{token}
| Empty JSON array is returned when you don't have any asset type registered |
| |||
Search assets | GET | /asset/search/{token}/{assetTypeIdOrKey}
|
| By default 100 assets is load per page | |||
Create or update asset | POST | /asset/save/{token}/{assetTypeIdOrKey} | Expecting an input payload in JSON format that describes new Asset Creates Asset
Updates asset by "id"
| ||||
Get asset by ID or key | GET | /asset/get/{token}/{assetTypeIdOrKey}/{assetIdOrKey} | |||||
Delete asset by ID or key | DELETE | /asset/delete/{token}/{assetTypeIdOrKey}/{assetIdOrKey} | |||||
HTTP 401 is returned when "Authentication token is missing" or "Invalid or expired token" is provided