{ "info": { "_postman_id": "a2e18d59-d1cd-4e5b-b41b-84d2933c9726", "name": "REST", "schema": "https://schema.getpostman.com/json/collection/v2.0.0/collection.json" }, "item": [ { "name": "Aql", "item": [ { "name": "/aql/objects", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}aql/objects", "query": [ { "key": "qlQuery", "value": "{{qlQuery}}", "disabled": true, "description": "The query to determine which objects that should be fetched. E.g. objectType = \"Computer\". The empty AQL means all objects" }, { "key": "page", "value": "{{page}}", "disabled": true, "description": "Which page to fetch when paginating through the response" }, { "key": "resultPerPage", "value": "{{resultPerPage}}", "disabled": true, "description": "The amount of objects returned per page" }, { "key": "includeAttributes", "value": "{{includeAttributes}}", "disabled": true, "description": "Should the objects attributes be included in the response. If this parameter is false only the information on the object will be returned and the object attributes will not be present" }, { "key": "includeAttributesDeep", "value": "{{includeAttributesDeep}}", "disabled": true, "description": "How many levels of attributes should be included. E.g. consider an object A that has a reference to object B that has a reference to object C. If object A is included in the response and includeAttributesDeep=1 object A's reference to object B will be included in the attributes of object A but object B's reference to object C will not be included. However if the includeAttributesDeep=2 then object B's reference to object C will be included in object B's attributes" }, { "key": "includeTypeAttributes", "value": "{{includeTypeAttributes}}", "disabled": true, "description": "Should the response include the object type attribute definition for each attribute that is returned with the objects" }, { "key": "includeExtendedInfo", "value": "{{includeExtendedInfo}}", "disabled": true, "description": "Include information about open Jira issues. Should each object have information if open tickets are connected to the object?" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Deprecated from 1 May 2024. Please use POST `/object/aql` instead. Find objects based on Assets Query Language (AQL)" }, "response": [] } ] }, { "name": "Icon", "item": [ { "name": "/icon/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}icon/:id", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Load a single icon by id" }, "response": [] }, { "name": "/icon/global", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}icon/global", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Return all global icons i.e. icons not associated with a particular object schema" }, "response": [] } ] }, { "name": "Import", "item": [ { "name": "/import/start/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}import/start/:id", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Start configured imports. To see an ongoing import see the Progress resource" }, "response": [] } ] }, { "name": "Importsource", "item": [ { "name": "/importsource/{uuid}/mapping", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}importsource/:uuid/mapping", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Provide object schema and mapping configuration for the external import", "body": { "mode": "raw", "raw": "{\n \"schema\": {\n \"objectSchema\": {\n \"name\": \"Disk Analysis Tool\",\n \"description\": \"Data imported from The Disk Analysis Tool\",\n \"objectTypes\": [\n {\n \"externalId\": \"object-type/hard-drive\",\n \"name\": \"Hard Drive\",\n \"description\": \"A hard drive found during scanning\",\n \"attributes\": [\n {\n \"externalId\": \"object-type-attribute/duid\",\n \"name\": \"DUID\",\n \"description\": \"Device Unique Identifier\",\n \"type\": \"text\",\n \"label\": true,\n \"minimumCardinality\": 1,\n \"maximumCardinality\": 1,\n \"unique\": false\n },\n {\n \"externalId\": \"object-type-attribute/disk-label\",\n \"name\": \"Disk Label\",\n \"description\": \"Hard drive label\",\n \"type\": \"text\",\n \"minimumCardinality\": 1,\n \"maximumCardinality\": 1,\n \"unique\": false\n },\n {\n \"externalId\": \"object-type-attribute/status\",\n \"name\": \"HardDriveStatus\",\n \"description\": \"The hard drive status\",\n \"type\": \"status\",\n \"typeValues\": [\n \"Schema Scope Status\",\n \"Global Scope Status\",\n \"New Status\"\n ]\n }\n ],\n \"children\": [\n {\n \"externalId\": \"object-type/file\",\n \"name\": \"File\",\n \"description\": \"A file present in a hard drive\",\n \"attributes\": [\n {\n \"externalId\": \"object-type-attribute/path\",\n \"name\": \"Path\",\n \"description\": \"Path of the file\",\n \"type\": \"text\",\n \"label\": true,\n \"minimumCardinality\": 1,\n \"maximumCardinality\": 1,\n \"unique\": false\n },\n {\n \"externalId\": \"object-type-attribute/size\",\n \"name\": \"Size\",\n \"description\": \"Size of the file\",\n \"type\": \"integer\",\n \"minimumCardinality\": 1,\n \"maximumCardinality\": 1,\n \"unique\": false\n }\n ]\n }\n ]\n }\n ]\n },\n \"statusSchema\": {\n \"statuses\": [\n {\n \"name\": \"New Status\",\n \"description\": \"\",\n \"category\": \"active\"\n }\n ]\n }\n },\n \"mapping\": {\n \"objectTypeMappings\": [\n {\n \"objectTypeExternalId\": \"object-type/hard-drive\",\n \"objectTypeName\": \"Hard Drive\",\n \"selector\": \"hardDrives\",\n \"description\": \"Mapping for Hard Drives\",\n \"attributesMapping\": [\n {\n \"attributeExternalId\": \"object-type-attribute/duid\",\n \"attributeName\": \"DUID\",\n \"attributeLocators\": [\n \"id\"\n ],\n \"externalIdPart\": true\n },\n {\n \"attributeExternalId\": \"object-type-attribute/disk-label\",\n \"attributeName\": \"Disk Label\",\n \"attributeLocators\": [\n \"label\"\n ]\n },\n {\n \"attributeExternalId\": \"object-type-attribute/status\",\n \"attributeName\": \"HardDriveStatus\",\n \"attributeLocators\": [\n \"status\"\n ]\n }\n ]\n },\n {\n \"objectTypeExternalId\": \"object-type/file\",\n \"objectTypeName\": \"File\",\n \"selector\": \"hardDrives.files\",\n \"description\": \"Maps files found in hard drives\",\n \"attributesMapping\": [\n {\n \"attributeExternalId\": \"object-type-attribute/path\",\n \"attributeName\": \"Path\",\n \"attributeLocators\": [\n \"path\"\n ],\n \"externalIdPart\": true\n },\n {\n \"attributeExternalId\": \"object-type-attribute/size\",\n \"attributeName\": \"Size\",\n \"attributeLocators\": [\n \"size\"\n ]\n }\n ]\n }\n ]\n }\n}" } }, "response": [] }, { "name": "/importsource/{uuid}/mapping", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}importsource/:uuid/mapping", "query": [], "variable": [] }, "method": "PATCH", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Update object schema and mapping configuration for the external import", "body": { "mode": "raw", "raw": "{\n \"$schema\": \"https://api.stg.atlassian.com/jsm/assets/imports/external/schema/versions/2021_09_15\",\n \"schema\": {\n \"objectSchema\": {\n \"name\": \"Disk Analysis Tool\",\n \"description\": \"Data imported from The Disk Analysis Tool\",\n \"objectTypes\": [\n {\n \"externalId\": \"object-type/hard-drive\",\n \"name\": \"Hard Drive\",\n \"description\": \"A hard drive found during scanning\",\n \"attributes\": [\n {\n \"externalId\": \"object-type-attribute/manufacturer\",\n \"name\": \"Manufacturer\",\n \"description\": \"Manufacturer name\",\n \"type\": \"text\"\n }\n ],\n \"children\": [\n {\n \"externalId\": \"object-type/folder\",\n \"name\": \"Folder\",\n \"description\": \"A folder present in a hard drive\",\n \"attributes\": [\n {\n \"externalId\": \"object-type-attribute/folder-name\",\n \"name\": \"Name\",\n \"description\": \"Folder name\",\n \"type\": \"text\",\n \"label\": true\n }\n ]\n },\n {\n \"externalId\": \"object-type/file\",\n \"name\": \"File\",\n \"description\": \"A file present in a hard drive\",\n \"attributes\": [\n {\n \"externalId\": \"object-type-attribute/path\",\n \"name\": \"Path\",\n \"description\": \"Updated description for the path attribute\",\n \"type\": \"text\",\n \"label\": true\n }\n ]\n }\n ]\n }\n ]\n }\n },\n \"mapping\": {\n \"objectTypeMappings\": [\n {\n \"objectTypeExternalId\": \"object-type/hard-drive\",\n \"objectTypeName\": \"Hard Drive\",\n \"selector\": \"hardDrives\",\n \"description\": \"Mapping for Hard Drives\",\n \"attributesMapping\": [\n {\n \"attributeExternalId\": \"object-type-attribute/duid\",\n \"attributeName\": \"DUID\",\n \"attributeLocators\": [\n \"id\"\n ],\n \"externalIdPart\": true\n },\n {\n \"attributeExternalId\": \"object-type-attribute/disk-label\",\n \"attributeName\": \"Disk Label\",\n \"attributeLocators\": [\n \"label\"\n ]\n },\n {\n \"attributeExternalId\": \"object-type-attribute/manufacturer\",\n \"attributeName\": \"Manufacturer\",\n \"attributeLocators\": [\n \"manufacturer\"\n ]\n }\n ]\n },\n {\n \"objectTypeExternalId\": \"object-type/folder\",\n \"objectTypeName\": \"Folder\",\n \"selector\": \"hardDrives.folders\",\n \"description\": \"Mapping for Folder\",\n \"attributesMapping\": [\n {\n \"attributeExternalId\": \"object-type-attribute/folder-name\",\n \"attributeName\": \"Name\",\n \"attributeLocators\": [\n \"name\"\n ],\n \"externalIdPart\": true\n }\n ]\n }\n ]\n }\n}" } }, "response": [] }, { "name": "/importsource/{importSourceId}/configstatus", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}importsource/:importSourceId/configstatus", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the current status of the import configuration" }, "response": [] }, { "name": "/importsource/{importSourceId}/schema-and-mapping", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}importsource/:importSourceId/schema-and-mapping", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the current schema and mapping of the import configuration" }, "response": [] }, { "name": "/importsource/{importSourceUuid}/executions", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}importsource/:importSourceUuid/executions", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Move to the data ingestion steps of external imports" }, "response": [] }, { "name": "/importsource/{importSourceUuid}/executions/{importExecutionUuid}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}importsource/:importSourceUuid/executions/:importExecutionUuid", "query": [], "variable": [] }, "method": "DELETE", "header": [], "description": "Cancel current on-going import" }, "response": [] }, { "name": "/importsource/{importSourceUuid}/executions/{importExecutionUuid}/progress", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}importsource/:importSourceUuid/executions/:importExecutionUuid/progress", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Submit progress of ingesting data", "body": { "mode": "raw", "raw": "{\n \"steps\": {\n \"total\": 3,\n \"current\": 2,\n \"description\": \"Gathering data\"\n },\n \"objects\": {\n \"total\": 500,\n \"processed\": 125\n }\n}" } }, "response": [] }, { "name": "/importsource/{importSourceUuid}/executions/{importExecutionUuid}/data", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}importsource/:importSourceUuid/executions/:importExecutionUuid/data", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Providing data to be ingested", "body": { "mode": "raw", "raw": "{\n \"data\": {\n \"hardDrives\": [\n {\n \"id\": \"Hard drive ID\",\n \"label\": \"Hard drive label\",\n \"files\": [\n {\n \"path\": \"/file/path\",\n \"size\": 123456\n }\n ]\n }\n ]\n },\n \"clientGeneratedId\": \"a-unique-id\",\n \"completed\": true\n}" } }, "response": [] }, { "name": "/importsource/{importSourceUuid}/executions/{importExecutionUuid}/status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}importsource/:importSourceUuid/executions/:importExecutionUuid/status", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the status of the import" }, "response": [] }, { "name": "/importsource/{importSourceUuid}/executions/status", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}importsource/:importSourceUuid/executions/status", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Get the status of the most recently created import execution" }, "response": [] }, { "name": "/importsource/{importSourceId}/token", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}importsource/:importSourceId/token", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Generate a Bearer token which can be used to authenticate against Assets `/importsource/` APIs, to take actions against the specified import source." }, "response": [] } ] }, { "name": "Iql", "item": [ { "name": "/iql/objects", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}iql/objects", "query": [ { "key": "iql", "value": "{{iql}}", "disabled": true, "description": "The query to determine which objects that should be fetched. E.g. objectType = \"Computer\". The empty AQL means all objects" }, { "key": "page", "value": "{{page}}", "disabled": true, "description": "Which page to fetch when paginating through the response" }, { "key": "resultPerPage", "value": "{{resultPerPage}}", "disabled": true, "description": "The amount of objects returned per page" }, { "key": "includeAttributes", "value": "{{includeAttributes}}", "disabled": true, "description": "Should the objects attributes be included in the response. If this parameter is false only the information on the object will be returned and the object attributes will not be present" }, { "key": "includeAttributesDeep", "value": "{{includeAttributesDeep}}", "disabled": true, "description": "How many levels of attributes should be included. E.g. consider an object A that has a reference to object B that has a reference to object C. If object A is included in the response and includeAttributesDeep=1 object A's reference to object B will be included in the attributes of object A but object B's reference to object C will not be included. However if the includeAttributesDeep=2 then object B's reference to object C will be included in object B's attributes" }, { "key": "includeTypeAttributes", "value": "{{includeTypeAttributes}}", "disabled": true, "description": "Should the response include the object type attribute definition for each attribute that is returned with the objects" }, { "key": "includeExtendedInfo", "value": "{{includeExtendedInfo}}", "disabled": true, "description": "Include information about open Jira issues. Should each object have information if open tickets are connected to the object?" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Deprecated. Please use POST `/object/aql` instead." }, "response": [] } ] }, { "name": "Object", "item": [ { "name": "/object/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}object/:id", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Load one object" }, "response": [] }, { "name": "/object/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}object/:id", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update an existing object in Assets", "body": { "mode": "raw", "raw": "{\n \"attributes\": [\n {\n \"objectTypeAttributeId\": \"265\",\n \"objectAttributeValues\": [\n {\n \"value\": \"A placeholder value\"\n }\n ]\n }\n ],\n \"objectTypeId\": \"23\",\n \"avatarUUID\": \"\",\n \"hasAvatar\": false\n}" } }, "response": [] }, { "name": "/object/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}object/:id", "query": [], "variable": [] }, "method": "DELETE", "header": [], "description": "Delete the referenced object" }, "response": [] }, { "name": "/object/{id}/attributes", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}object/:id/attributes", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "List all attributes for the given object" }, "response": [] }, { "name": "/object/{id}/history", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}object/:id/history", "query": [ { "key": "asc", "value": "{{asc}}", "disabled": true, "description": "Should the history be retrieved in ascending order" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve the history entries for this object" }, "response": [] }, { "name": "/object/{id}/referenceinfo", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}object/:id/referenceinfo", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Find all references for an object" }, "response": [] }, { "name": "/object/create", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}object/create", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create a new object in Assets", "body": { "mode": "raw", "raw": "{\n \"objectTypeId\": \"23\",\n \"attributes\": [\n {\n \"objectTypeAttributeId\": \"135\",\n \"objectAttributeValues\": [\n {\n \"value\": \"NY-1\"\n }\n ]\n },\n {\n \"objectTypeAttributeId\": \"144\",\n \"objectAttributeValues\": [\n {\n \"value\": \"99\"\n }\n ]\n }\n ]\n}" } }, "response": [] }, { "name": "/object/navlist/aql", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}object/navlist/aql", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Retrieve a list of objects based on an AQL. Note that the preferred endpoint is /aql", "body": { "mode": "raw", "raw": "{\n \"objectTypeId\": \"23\",\n \"attributesToDisplay\": {\n \"attributesToDisplayIds\": [\n \"135\",\n \"144\"\n ]\n },\n \"page\": 1,\n \"asc\": 1,\n \"resultsPerPage\": 25,\n \"includeAttributes\": false,\n \"objectSchemaId\": \"6\",\n \"qlQuery\": \"objectType = Office AND Name LIKE SYD\"\n}" } }, "response": [] }, { "name": "/object/navlist/iql", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}object/navlist/iql", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Deprecated. Use `/object/navlist/aql` instead.", "body": { "mode": "raw", "raw": "{\n \"objectTypeId\": \"23\",\n \"attributesToDisplay\": {\n \"attributesToDisplayIds\": [\n 135,\n 144\n ]\n },\n \"page\": 1,\n \"asc\": 1,\n \"resultsPerPage\": 25,\n \"includeAttributes\": false,\n \"objectSchemaId\": \"6\",\n \"iql\": \"objectType = Office AND Name LIKE SYD\"\n}" } }, "response": [] }, { "name": "/object/aql", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}object/aql", "query": [ { "key": "startAt", "value": "{{startAt}}", "disabled": true, "description": "The starting index for the next page of results" }, { "key": "maxResults", "value": "{{maxResults}}", "disabled": true, "description": "The maximum number of objects to return in this page of results. Actual number of results may be less, for example, if the last page of results is returned." }, { "key": "includeAttributes", "value": "{{includeAttributes}}", "disabled": true, "description": "Should the objects attributes be included in the response. If this parameter is false only the information on the object will be returned and the object attributes will not be present" } ], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Fetch Objects by AQL", "body": { "mode": "raw", "raw": "{\n \"qlQuery\": \"objectType = Office AND Name LIKE SYD\"\n}" } }, "response": [] } ] }, { "name": "Objectconnectedtickets", "item": [ { "name": "/objectconnectedtickets/{objectId}/tickets", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objectconnectedtickets/:objectId/tickets", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Relation between Jira issues and Assets objects" }, "response": [] } ] }, { "name": "Objectschema", "item": [ { "name": "/objectschema/list", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objectschema/list", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Resource to find object schemas in Assets" }, "response": [] }, { "name": "/objectschema/create", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objectschema/create", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create a new object schema", "body": { "mode": "raw", "raw": "{\n \"name\": \"Computers\",\n \"objectSchemaKey\": \"COMP\",\n \"description\": \"The IT department schema\"\n}" } }, "response": [] }, { "name": "/objectschema/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objectschema/:id", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Find a schema by id" }, "response": [] }, { "name": "/objectschema/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objectschema/:id", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update an object schema", "body": { "mode": "raw", "raw": "{\n \"name\": \"Computers\",\n \"objectSchemaKey\": \"COMP\",\n \"description\": \"The IT department schema\"\n}" } }, "response": [] }, { "name": "/objectschema/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objectschema/:id", "query": [], "variable": [] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Delete a schema" }, "response": [] }, { "name": "/objectschema/{id}/attributes", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objectschema/:id/attributes", "query": [ { "key": "onlyValueEditable", "value": "{{onlyValueEditable}}", "disabled": true, "description": "Return only values that are associated with values that can be edited" }, { "key": "extended", "value": "{{extended}}", "disabled": true, "description": "Include the object type with each object type attribute" }, { "key": "query", "value": "{{query}}", "disabled": true, "description": "A query that will be used to filter object type attributes by their name" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Find all object type attributes for this object schema" }, "response": [] }, { "name": "/objectschema/{id}/objecttypes", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objectschema/:id/objecttypes", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Find all object types for this object schema" }, "response": [] }, { "name": "/objectschema/{id}/objecttypes/flat", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objectschema/:id/objecttypes/flat", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Find all object types for this object schema" }, "response": [] } ] }, { "name": "Objecttype", "item": [ { "name": "/objecttype/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objecttype/:id", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Find an object type by id" }, "response": [] }, { "name": "/objecttype/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objecttype/:id", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update an existing object type", "body": { "mode": "raw", "raw": "" } }, "response": [] }, { "name": "/objecttype/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objecttype/:id", "query": [], "variable": [] }, "method": "DELETE", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Delete an object type" }, "response": [] }, { "name": "/objecttype/{id}/attributes", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objecttype/:id/attributes", "query": [ { "key": "onlyValueEditable", "value": "{{onlyValueEditable}}", "disabled": true }, { "key": "orderByName", "value": "{{orderByName}}", "disabled": true }, { "key": "query", "value": "{{query}}", "disabled": true }, { "key": "includeValuesExist", "value": "{{includeValuesExist}}", "disabled": true }, { "key": "excludeParentAttributes", "value": "{{excludeParentAttributes}}", "disabled": true }, { "key": "includeChildren", "value": "{{includeChildren}}", "disabled": true }, { "key": "orderByRequired", "value": "{{orderByRequired}}", "disabled": true } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Find all attributes for this object type" }, "response": [] }, { "name": "/objecttype/{id}/position", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objecttype/:id/position", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Change position of this object type", "body": { "mode": "raw", "raw": "{\n \"toObjectTypeId\": \"2\",\n \"position\": 0\n}" } }, "response": [] }, { "name": "/objecttype/create", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objecttype/create", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create a new object type", "body": { "mode": "raw", "raw": "{\n \"inherited\": false,\n \"abstractObjectType\": false,\n \"objectSchemaId\": \"6\",\n \"iconId\": \"13\",\n \"name\": \"Office\",\n \"description\": \"Lorem ipsum dolor sit amet, consectetur adipiscing elit. Proin nec ex.\"\n}" } }, "response": [] } ] }, { "name": "Objecttypeattribute", "item": [ { "name": "/objecttypeattribute/{objectTypeId}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objecttypeattribute/:objectTypeId", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create a new attribute on the given object type", "body": { "mode": "raw", "raw": "{\n \"name\": \"Geolocation\",\n \"type\": \"0\",\n \"defaultTypeId\": \"0\"\n}" } }, "response": [] }, { "name": "/objecttypeattribute/{objectTypeId}/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objecttypeattribute/:objectTypeId/:id", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update an existing object type attribute", "body": { "mode": "raw", "raw": "{\n \"description\": \"GPS coordinates of the office\"\n}" } }, "response": [] }, { "name": "/objecttypeattribute/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}objecttypeattribute/:id", "query": [], "variable": [] }, "method": "DELETE", "header": [], "description": "Delete an existing object type attribute" }, "response": [] } ] }, { "name": "Operations", "item": [ { "name": "[EXPERIMENTAL] Get List of Templates", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}operations/template/list", "query": [], "variable": [] }, "method": "GET", "header": [ { "key": "X-Experimental", "value": "{{X-Experimental}}", "disabled": false }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "**This is an experimental API.** This means that this is an opt-in, early access preview of the IT Assets object schema template before we release it officially as part of the experience in Assets in the near future. This also means that the by using this API, you agree to opt-in and understand that this API may change without notice. If you have any suggestions for improvements or feedback about the template and its contents - we'd love to hear from you! Please add a comment to the developer community post page, or submit your thoughts via this form. **To use an experimental API, you must include the `X-Experimental: opt-in` header in your requests.** Returns a list of templates. To create a schema using one of these templates, call the `POST operations/structurefromtemplate` endpoint with the template's `templateId`." }, "response": [] }, { "name": "[EXPERIMENTAL] Creates structure from template", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}operations/structurefromtemplate", "query": [], "variable": [] }, "method": "POST", "header": [ { "key": "X-Experimental", "value": "{{X-Experimental}}", "disabled": false }, { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "**This is an experimental API.** This means that this is an opt-in, early access preview of the IT Assets object schema template before we release it officially as part of the experience in Assets in the near future. This also means that the by using this API, you agree to opt-in and understand that this API may change without notice. If you have any suggestions for improvements or feedback about the template and its contents - we'd love to hear from you! Please add a comment to the developer community post page, or submit your thoughts via this form. **To use an experimental API, you must include the `X-Experimental: opt-in` header in your requests.**Creates a structure from a template. A structure refers to a schema that also contains object types, object attributes, reference types, status types etc. A structure doesn't include any objects. All entities will be created in the newly created schema. This won't modify other schemas or the global configuration. If you provide a `name` or `objectSchemaKey` that already exists, this will return an error. The `it_assets_management` template is a well-organized IT assets catalogue used for tracking all types of IT assets.", "body": { "mode": "raw", "raw": "{\n \"templateId\": \"it_assets_management\",\n \"variables\": {\n \"objectSchemaKey\": \"EXA\",\n \"name\": \"Example IT Assets Management Schema\",\n \"description\": \"This is an example IT assets management schema\"\n }\n}" } }, "response": [] } ] }, { "name": "Progress", "item": [ { "name": "/progress/category/imports/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}progress/category/imports/:id", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Show ongoing import process" }, "response": [] } ] }, { "name": "Config", "item": [ { "name": "/config/statustype", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}config/statustype", "query": [ { "key": "objectSchemaId", "value": "{{objectSchemaId}}", "disabled": true, "description": "Include statuses for the object schema id. If supplied statuses for the object schema will be returned otherwise all global will be returned" } ], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Find all status" }, "response": [] }, { "name": "/config/statustype", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}config/statustype", "query": [], "variable": [] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Create a new status", "body": { "mode": "raw", "raw": "{\n \"name\": \"Decommissioned\",\n \"category\": 0,\n \"objectSchemaId\": \"6\"\n}" } }, "response": [] }, { "name": "/config/statustype/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}config/statustype/:id", "query": [], "variable": [] }, "method": "GET", "header": [ { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Find a status by id" }, "response": [] }, { "name": "/config/statustype/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}config/statustype/:id", "query": [], "variable": [] }, "method": "PUT", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" }, { "description": "", "disabled": false, "key": "Accept", "value": "application/json" } ], "description": "Update an existing status", "body": { "mode": "raw", "raw": "{\n \"name\": \"Decommissioned\",\n \"category\": 0,\n \"objectSchemaId\": \"6\"\n}" } }, "response": [] }, { "name": "/config/statustype/{id}", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}config/statustype/:id", "query": [], "variable": [] }, "method": "DELETE", "header": [], "description": "Delete an existing status" }, "response": [] } ] }, { "name": "Global", "item": [ { "name": "/global/config/objectschema/{id}/property", "request": { "url": { "protocol": "{{protocol}}", "host": "{{host}}", "path": "{{basePath}}global/config/objectschema/:id/property", "query": [], "variable": [ { "key": "id", "value": "{{id}}", "description": "Object schema id", "disabled": false } ] }, "method": "POST", "header": [ { "description": "", "disabled": false, "key": "Content-Type", "value": "application/json" } ], "description": "Update general configuration for object schema", "body": { "mode": "raw", "raw": "{\n \"allowOtherObjectSchema\": true,\n \"validateQuickCreate\": true,\n \"quickCreateObjects\": true\n}" } }, "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": "jsm/assets/workspace/%7BworkspaceId%7D/v1/" } ] }