• Aql
    • Icon
    • Import
    • Importsource
    • Iql
    • Object
    • Objectconnectedtickets
    • Objectschema
    • Objecttype
    • Objecttypeattribute
    • Operations
    • Progress
    • Config
    • Global
    Cloud
    Assets / Guides / REST API

    Operations

    Postman Collection
    OpenAPI
    GET

    [EXPERIMENTAL] Get List of TemplatesExperimental

    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.

    Request

    Header parameters

    X-Experimental

    string

    Required

    Responses

    application/json

    any

    GET/operations/template/list
    1 2 3 curl --request GET \ --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/operations/template/list' \ --header 'Accept: application/json'
    200Response
    1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 { "templates": [ { "templateId": "it_assets_management", "ui": { "sidebar": { "title": "IT assets management" }, "header": { "title": "IT assets management template" }, "details": { "title": "Benefits of using this template", "summary": "This schema template will help you create a well-organized IT service catalog to showcase the IT equipment and services your organization offers and supports. Streamline equipment requests and improve tracking capabilities with a comprehensive structure for tracking and managing equipment models and specific instances of those models. This template is suitable for IT service providers, internal IT departments, and any organization seeking a structured approach to managing their IT assets.", "sections": [ { "heading": "Track all types of IT assets", "description": "Manage both general equipment models and individual instances (e.g., MacBook Pro and LAP-APP-01) for improved asset management.", "icon": "icon1" }, { "heading": "Level up with other schemas", "description": "Integrates with other templates like People and Facilities, allowing for a comprehensive IT Service Management system tailored to your organizations needs.", "icon": "icon2" }, { "heading": "Speed up your processes", "description": "Enhanced decision-making: Facilitates informed decisions on equipment and support offerings by providing a holistic view of your IT environment.", "icon": "icon3" } ], "additionalInfo": { "title": "rlabs.insight.i18n.templates.it_assets_management.ui.details.additionalInfo.title", "summary": "Treat this template as a starting point, it?ll give you a solid foundation for creating an effective IT service catalog. However, remember to embrace simplicity - start small, focus on your use case, adapt, and continuously update your catalog to get the most out of it. When you?re ready, level up your efficiency by connecting to other relevant schemas, adding automation rules to remove manual work out and implement custom field integrations to surface information where you need it. Learn more about advanced uses of Assets schemas.", "icon": "TODO" } } }, "operations": [ { "operation": { "name": "declare_schema" }, "entity": { "type": "object_schema", "key": "{{objectSchemaKey}}", "name": "{{name}}", "description": "{{description}}", "externalId": "63717c4f-2984-4236-bebb-27f39d07231c/schema" } }, { "operation": { "name": "declare_object_type" }, "entity": { "type": "object_type", "schemaExternalId": "63717c4f-2984-4236-bebb-27f39d07231c/schema", "attributes": [ { "name": "Model ID", "defaultTypeId": 0, "kindOfAttribute": "text" }, { "name": "Manufacturer", "defaultTypeId": 0, "kindOfAttribute": "text" }, { "name": "Category", "defaultTypeId": 0, "options": "Desktop,Laptop,Network gear,Point of sale,Printer,Server,Smart phone,Software license,Storage Tablet", "kindOfAttribute": "select" }, { "name": "Bar code", "defaultTypeId": 0, "kindOfAttribute": "text" }, { "name": "Description", "defaultTypeId": 0, "kindOfAttribute": "text" }, { "name": "Product Information", "defaultTypeId": 0, "kindOfAttribute": "textarea" }, { "name": "Unit Price", "defaultTypeId": 0, "kindOfAttribute": "int" }, { "name": "Status", "defaultTypeId": 0, "kindOfAttribute": "status" } ], "name": "Models", "externalId": "63717c4f-2984-4236-bebb-27f39d07231c/models" } }, { "operation": { "name": "declare_object_type" }, "entity": { "type": "object_type", "schemaExternalId": "63717c4f-2984-4236-bebb-27f39d07231c/schema", "attributes": [ { "name": "Asset Name", "defaultTypeId": 0, "description": "The name of the object", "kindOfAttribute": "text" }, { "name": "Asset Tag", "defaultTypeId": 0, "kindOfAttribute": "text" }, { "name": "Serial Number", "defaultTypeId": 0, "kindOfAttribute": "text" }, { "name": "PO Number", "defaultTypeId": 0, "kindOfAttribute": "text" }, { "name": "Invoice Number", "defaultTypeId": 0, "kindOfAttribute": "text" }, { "name": "Lease Contract", "defaultTypeId": 0, "kindOfAttribute": "text" }, { "name": "Maintenance Contract", "defaultTypeId": 0, "kindOfAttribute": "text" }, { "name": "Purchase Date", "defaultTypeId": 0, "kindOfAttribute": "date" }, { "name": "Refresh Date", "defaultTypeId": 0, "kindOfAttribute": "date" }, { "name": "Last Scan Date", "defaultTypeId": 0, "kindOfAttribute": "date" }, { "name": "Ownership Type", "defaultTypeId": 0, "options": "BYOD,Company owned", "kindOfAttribute": "select" }, { "name": "Owner Group", "defaultTypeId": 0, "kindOfAttribute": "text" }, { "name": "Device Type", "defaultTypeId": 0, "options": "Physical,Virtual", "kindOfAttribute": "select" }, { "name": "Asset Status", "defaultTypeId": 0, "description": "Status of asset (e.g., In stock, In use, etc.)", "kindOfAttribute": "status" }, { "name": "OS Version", "defaultTypeId": 0, "kindOfAttribute": "text" }, { "name": "Support Group", "defaultTypeId": 0, "kindOfAttribute": "text" }, { "name": "Operational Status", "defaultTypeId": 0, "description": "Health status of asset/CI", "kindOfAttribute": "status" }, { "name": "Status", "defaultTypeId": 0, "description": "Status of record", "kindOfAttribute": "status" }, { "name": "Model Name", "additionalValue": "1", "defaultTypeId": 0, "type": 1, "objectReferenceTypeExternalId": "63717c4f-2984-4236-bebb-27f39d07231c/models", "kindOfAttribute": "referenced-object" } ], "name": "Hardware", "inherited": true, "externalId": "63717c4f-2984-4236-bebb-27f39d07231c/hardware" } }, { "operation": { "name": "declare_object_type" }, "entity": { "type": "object_type", "schemaExternalId": "63717c4f-2984-4236-bebb-27f39d07231c/schema", "attributes": [ { "name": "IMEI", "defaultTypeId": 0, "kindOfAttribute": "text" }, { "name": "Phone number", "defaultTypeId": 0, "kindOfAttribute": "text" } ], "name": "Phones", "parentObjectTypeExternalId": "63717c4f-2984-4236-bebb-27f39d07231c/hardware", "externalId": "63717c4f-2984-4236-bebb-27f39d07231c/phones" } }, { "operation": { "name": "declare_object_type" }, "entity": { "type": "object_type", "schemaExternalId": "63717c4f-2984-4236-bebb-27f39d07231c/schema", "attributes": [], "name": "Laptops", "parentObjectTypeExternalId": "63717c4f-2984-4236-bebb-27f39d07231c/hardware", "externalId": "63717c4f-2984-4236-bebb-27f39d07231c/laptops" } }, { "operation": { "name": "declare_object_type" }, "entity": { "type": "object_type", "schemaExternalId": "63717c4f-2984-4236-bebb-27f39d07231c/schema", "attributes": [ { "name": "IP Address", "defaultTypeId": 0, "kindOfAttribute": "text" }, { "name": "Domain Name", "defaultTypeId": 0, "kindOfAttribute": "text" }, { "name": "Application Instance", "defaultTypeId": 0, "kindOfAttribute": "text" } ], "name": "Servers", "parentObjectTypeExternalId": "63717c4f-2984-4236-bebb-27f39d07231c/hardware", "externalId": "63717c4f-2984-4236-bebb-27f39d07231c/servers" } }, { "operation": { "name": "declare_object_type" }, "entity": { "type": "object_type", "schemaExternalId": "63717c4f-2984-4236-bebb-27f39d07231c/schema", "attributes": [], "name": "Red Hat Linux", "parentObjectTypeExternalId": "63717c4f-2984-4236-bebb-27f39d07231c/servers", "externalId": "63717c4f-2984-4236-bebb-27f39d07231c/red-hat-linux" } }, { "operation": { "name": "declare_object_type" }, "entity": { "type": "object_type", "schemaExternalId": "63717c4f-2984-4236-bebb-27f39d07231c/schema", "attributes": [], "name": "Windows Server", "parentObjectTypeExternalId": "63717c4f-2984-4236-bebb-27f39d07231c/servers", "externalId": "63717c4f-2984-4236-bebb-27f39d07231c/windows-server" } }, { "operation": { "name": "declare_object_type" }, "entity": { "type": "object_type", "schemaExternalId": "63717c4f-2984-4236-bebb-27f39d07231c/schema", "attributes": [], "name": "Printers", "parentObjectTypeExternalId": "63717c4f-2984-4236-bebb-27f39d07231c/hardware", "externalId": "63717c4f-2984-4236-bebb-27f39d07231c/printers" } } ] } ] }
    POST

    [EXPERIMENTAL] Creates structure from templateExperimental

    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.

    Request

    Header parameters

    X-Experimental

    string

    Required

    Request bodyapplication/json

    templateId

    string

    Required
    variables

    object

    Required

    Responses

    This status code has no content.

    POST/operations/structurefromtemplate
    1 2 3 4 5 6 7 8 9 10 11 curl --request POST \ --url 'https://api.atlassian.com/jsm/assets/workspace/{workspaceId}/v1/operations/structurefromtemplate' \ --header 'Content-Type: application/json' \ --data '{ "templateId": "it_assets_management", "variables": { "objectSchemaKey": "EXA", "name": "Example IT Assets Management Schema", "description": "This is an example IT assets management schema" } }'