{ "info": { "_postman_id": "d7ffbbe7-7e86-4da6-ac32-45e63be766b1", "name": "External Assets Platform API", "description": "Assets are identified by `appKey/originId` which is defined in the `origin` field as part of creation. They need to be URL-safe and unique within a Jira instance. We recommend `appKey` to be the same as the Connect descriptor key if possible, otherwise it can be an arbitrary value.", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" }, "item": [ { "name": "Assets", "description": "This resource represents assets in Jira. These assets may have been populated in Jira from another application. Use this resource to get, search for, create, update, and delete assets in Jira.", "item": [ { "name": "Bulk create or update assets", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}asset/bulk", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Creates new assets or updates existing assets. Note that updating assets will overwrite their properties with the properties defined in the request object.\n\n", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get all assets", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}asset", "query": [ { "key": "type", "value": "{{type}}", "disabled": true, "description": "The asset type to filter by. Set this to the concatenation of the asset type’s `appKey` and `originId`, in the format `appKey/originId`." }, { "key": "start", "value": "{{start}}", "disabled": true, "description": "The index of the first item to return in a page of results (page offset)." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of items to return per page. Note that this may be constrained by the External Assets Platform service." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Returns a list of all assets" }, "response": [] }, { "name": "Create or update asset", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}asset", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Creates a new asset or updates an existing asset. Note that updating an asset will overwrite its properties with the properties defined in the request object.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Get an asset by its origin", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}asset/:appKey/:originId", "query": [], "variable": [ { "key": "appKey", "value": "{{appKey}}", "description": "The app key, which should be the Connect app key. This parameter is used to scope the `originId`.", "disabled": false }, { "key": "originId", "value": "{{originId}}", "description": "The identifier of an asset/asset type. This is the same identifier for the asset/asset type in its origin (external) system.", "disabled": false } ] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ] }, "response": [] }, { "name": "Delete an asset", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}asset/:appKey/:originId", "query": [], "variable": [ { "key": "appKey", "value": "{{appKey}}", "description": "The app key, which should be the Connect app key. This parameter is used to scope the `originId`.", "disabled": false }, { "key": "originId", "value": "{{originId}}", "description": "The identifier of an asset/asset type. This is the same identifier for the asset/asset type in its origin (external) system.", "disabled": false } ] }, "method": "DELETE", "header": [] }, "response": [] }, { "name": "Search assets", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}asset/search", "query": [ { "key": "query", "value": "{{query}}", "disabled": true, "description": "The search term that will be matched with either *label*, *origin* or *fields* values." }, { "key": "type", "value": "{{type}}", "disabled": true, "description": "The asset type to filter the search by. Set this to the concatenation of the asset type’s `appKey` and `originId`, in the format `appKey/originId`." }, { "key": "assignee", "value": "{{assignee}}", "disabled": true, "description": "The assignees to filter the search by. Set one of these values to `unassigned` if you want to include `unassigned` assets." }, { "key": "prioritizedAssignee", "value": "{{prioritizedAssignee}}", "disabled": true, "description": "The assignee the search is prioritized by. This means that results with an assignee matching this one will be promoted to the top of the list. If multiple prioritizedAssignee parameters are specified, only the first one will be used." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of items to return per page. Note that this may be constrained by the External Assets Platform service." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Searches assets matching the `query` parameter. Only assets with an appKey matching an installed asset management app will be returned. If no asset management apps are installed, falls back to returning all assets." }, "response": [] } ] }, { "name": "Asset types", "description": "This resource represents asset types in Jira. Asset types are used to categorize assets. Use this resource to get, create, update, and delete assets in Jira.", "item": [ { "name": "Get all asset types", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}asset/type", "query": [ { "key": "start", "value": "{{start}}", "disabled": true, "description": "The index of the first item to return in a page of results (page offset)." }, { "key": "limit", "value": "{{limit}}", "disabled": true, "description": "The maximum number of items to return per page. Note that this may be constrained by the External Assets platform service." } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Fetches all available asset types. Only asset types with an appKey matching an installed asset management app will be returned. If no asset management apps are installed, falls back to returning all asset types." }, "response": [] }, { "name": "Create or update an asset type", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}asset/type", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Creates a new asset type or updates an existing asset type. Note that updating an asset type will overwrite its properties with the properties defined in the request object.", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "Delete an asset type", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}asset/type/:appKey/:originId", "query": [], "variable": [ { "key": "appKey", "value": "{{appKey}}", "description": "The app key, which should be the Connect app key. This parameter is used to scope the `originId`.", "disabled": false }, { "key": "originId", "value": "{{originId}}", "description": "The identifier of an asset/asset type. This is the same identifier for the asset/asset type in its origin (external) system.", "disabled": false } ] }, "method": "DELETE", "header": [] }, "response": [] } ] } ], "variable": [ { "key": "protocol", "name": "Protocol", "description": "The HTTP Protocol that should be used for this REST API.", "type": "string", "value": "https" }, { "key": "host", "name": "Host", "description": "The HTTP host that should be used for this REST API.", "type": "string", "value": "api.atlassian.com" }, { "key": "basePath", "name": "Base Path", "description": "The path, after the host, of the base of the REST API.", "type": "string", "value": "rest/assetapi/" } ] }