Asset Types

Find asset types matching criteria

get

Returns asset types matching the given search criteria. Only parameters that are specified in this request and have not null values are used for filtering. All other parameters are ignored. By default a result containing 1000 asset types is returned.

Authorizations

AuthorizationstringRequired

Query parameters

offsetinteger · int32Optional

The first result to retrieve. If not set (offset = 0), results will be retrieved starting from row 0.

Default: 0

limitinteger · int32Optional

The maximum number of results to retrieve. If not set (limit = 0), the default limit will be used. The maximum allowed limit is 1000.

Default: 0

countLimitinteger · int32Optional

Allows to limit the number of elements that will be counted. -1 will count everything and 0 will cause the count to be skipped

Default: -1

namestringOptional

The name of the Asset Type to search for.

nameMatchModestring · enumOptional

The match mode used to compare name. If the match mode is EXACT the search is case-sensitive, otherwise the search is case-insensitive.

Default: ANYWHEREPossible values:

parentIdstring · uuidOptional

The ID of the parent to find the Asset Types in.

excludeMetabooleanOptional

Whether the meta Asset Types should be excluded from the results or not.

Default: true

excludeFinalbooleanOptional

Whether the final Asset Types should be excluded from the results or not.

Default: false

excludeUnlicensedProductsbooleanOptional

Whether the Asset Types belonging to products for which no license is active should be excluded from the results or not.

Default: false

topLevelbooleanOptional

Whether only top level Asset Types should be searched or not.

Default: false

displayNameEnabledbooleanOptional

Whether only Asset Types with display names enabled (or disabled) should be searched.

Responses

200

Search ran successfully

application/json

totalinteger · int64Optional

The total number of results.

Example: 1000

offsetinteger · int64Optional

The offset for the results.

Example: 10

limitinteger · int64Optional

The maximum number of results to be returned.

Example: 100

get/assetTypes

GET /rest/2.0/assetTypes HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

Search ran successfully

{
  "total": 1000,
  "offset": 10,
  "limit": 100,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "name": "Test name",
      "description": "Sample descripion of the resource.",
      "publicId": "\"TechnicalReport_C\"",
      "parent": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "symbolData": {
        "color": "text",
        "symbolType": "NONE",
        "iconCode": "text",
        "acronymCode": "text"
      },
      "displayNameEnabled": true,
      "ratingEnabled": true,
      "finalType": true,
      "lockStatuses": true,
      "product": "text",
      "appliedTraits": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "trait": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          },
          "system": true
        }
      ]
    }
  ]
}

Add asset type

post

Adds a new asset type with the given parameters.

Authorizations

AuthorizationstringRequired

Body

idstring · uuidOptional

The UUID that will be assigned to the new Asset Type. It should be unique within all Asset Types, and should not start with 00000000-0000-0000- which is a reserved prefix.

publicIdstring · min: 1 · max: 260Optional

The public id that will be assigned to the new Asset Type. It must be unique within all Asset Types, Complex Relation Types, Domain Types and Scopes. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C". If no public id is provided, a valid public id will be generated.

namestring · min: 1 · max: 255Required

The name of the new Asset Type. Should be unique within all Asset Types.

Example: Sample Asset Type

descriptionstring · max: 4000Optional

The description of the new Asset Type.

Example: Example of Asset Type creation from the REST API documentation

colorstring · max: 7Optional

The color of the symbol in hex format.

Example: #ff0000Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$

symbolTypestring · enumRequired

The symbol type.

Possible values:

iconCodestringOptional

The icon code, a code representing the icon that should be shown.

acronymCodestringOptional

A code representing the acronym that should be shown.

Example: TSTPattern: ^([A-Za-z0-9]{1,4})$

parentIdstring · uuidOptional

The ID of the parent for the new Asset Type.

Example: 00000000-0000-0000-0000-000000011001

displayNameEnabledbooleanRequired

Whether the display name should be enabled for all Assets of the type being created.

ratingEnabledbooleanRequired

Whether ratings should be enabled for all Assets of the type being created.

Responses

201

Asset type successfully added.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

The type of the resource, e.g. [Community, Asset, Domain, Attribute, Relation, WorkflowInstance, ...]. This property is deprecated and will be removed in the future. In order to stay backwards compatible and to enable introduction of new types of resources, where necessary, a resource discriminator property (of type String) has been added to specific subtypes of Resource, e.g. assignedResourceDiscriminator on AssignedResource, or attributeDiscriminator on Attribute. For new types of resource that didn't exist before this change, the resourceType will be BaseDataType.

Possible values:

namestringOptional

The name of the resource.

Example: Test name

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

publicIdstringOptional

The public id of the asset type.

Example: "TechnicalReport_C"

displayNameEnabledbooleanOptional

ratingEnabledbooleanOptional

finalTypebooleanOptional

Whether the ability to create child asset types and scoped assignments for this asset type is locked.

lockStatusesbooleanOptional

Whether the ability to add custom statuses to the assignments of this asset type is locked.

productstringOptional

The product to which this asset type is linked.

400

An asset type with the given ID already exists

404

Parent asset type not found

post/assetTypes

POST /rest/2.0/assetTypes HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 342

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "publicId": "text",
  "name": "Sample Asset Type",
  "description": "Example of Asset Type creation from the REST API documentation",
  "color": "#ff0000",
  "symbolType": "NONE",
  "iconCode": "text",
  "acronymCode": "TST",
  "parentId": "00000000-0000-0000-0000-000000011001",
  "displayNameEnabled": true,
  "ratingEnabled": true
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "description": "Sample descripion of the resource.",
  "publicId": "\"TechnicalReport_C\"",
  "parent": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "symbolData": {
    "color": "text",
    "symbolType": "NONE",
    "iconCode": "text",
    "acronymCode": "text"
  },
  "displayNameEnabled": true,
  "ratingEnabled": true,
  "finalType": true,
  "lockStatuses": true,
  "product": "text",
  "appliedTraits": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "trait": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "system": true
    }
  ]
}

Add multiple asset types

post

Adds multiple asset types in one go.

Authorizations

AuthorizationstringRequired

Bodyobject · AddAssetTypeRequest[]

idstring · uuidOptional

The UUID that will be assigned to the new Asset Type. It should be unique within all Asset Types, and should not start with 00000000-0000-0000- which is a reserved prefix.

publicIdstring · min: 1 · max: 260Optional

namestring · min: 1 · max: 255Required

The name of the new Asset Type. Should be unique within all Asset Types.

Example: Sample Asset Type

descriptionstring · max: 4000Optional

The description of the new Asset Type.

Example: Example of Asset Type creation from the REST API documentation

colorstring · max: 7Optional

The color of the symbol in hex format.

Example: #ff0000Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$

symbolTypestring · enumRequired

The symbol type.

Possible values:

iconCodestringOptional

The icon code, a code representing the icon that should be shown.

acronymCodestringOptional

A code representing the acronym that should be shown.

Example: TSTPattern: ^([A-Za-z0-9]{1,4})$

parentIdstring · uuidOptional

The ID of the parent for the new Asset Type.

Example: 00000000-0000-0000-0000-000000011001

displayNameEnabledbooleanRequired

Whether the display name should be enabled for all Assets of the type being created.

ratingEnabledbooleanRequired

Whether ratings should be enabled for all Assets of the type being created.

Responses

201

Asset types successfully added.

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

publicIdstringOptional

The public id of the asset type.

Example: "TechnicalReport_C"

displayNameEnabledbooleanOptional

ratingEnabledbooleanOptional

finalTypebooleanOptional

Whether the ability to create child asset types and scoped assignments for this asset type is locked.

lockStatusesbooleanOptional

Whether the ability to add custom statuses to the assignments of this asset type is locked.

productstringOptional

The product to which this asset type is linked.

post/assetTypes/bulk

POST /rest/2.0/assetTypes/bulk HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 344

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "publicId": "text",
    "name": "Sample Asset Type",
    "description": "Example of Asset Type creation from the REST API documentation",
    "color": "#ff0000",
    "symbolType": "NONE",
    "iconCode": "text",
    "acronymCode": "TST",
    "parentId": "00000000-0000-0000-0000-000000011001",
    "displayNameEnabled": true,
    "ratingEnabled": true
  }
]

201

Asset types successfully added.

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "name": "Test name",
    "description": "Sample descripion of the resource.",
    "publicId": "\"TechnicalReport_C\"",
    "parent": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    },
    "symbolData": {
      "color": "text",
      "symbolType": "NONE",
      "iconCode": "text",
      "acronymCode": "text"
    },
    "displayNameEnabled": true,
    "ratingEnabled": true,
    "finalType": true,
    "lockStatuses": true,
    "product": "text",
    "appliedTraits": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "trait": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        },
        "system": true
      }
    ]
  }
]

Remove multiple asset types

delete

Removes multiple asset types identified by the given IDs.

Authorizations

AuthorizationstringRequired

Bodystring · uuid[]

string · uuid[]Optional

Responses

204

Asset types removed

No content

delete/assetTypes/bulk

DELETE /rest/2.0/assetTypes/bulk HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 40

[
  "123e4567-e89b-12d3-a456-426614174000"
]

204

Asset types removed

No content

Change multiple asset types

patch

Changes multiple asset types using the given parameters.

Authorizations

AuthorizationstringRequired

Bodyobject · ChangeAssetTypeRequest[]

idstring · uuidRequired

The ID of the Asset Type to be changed. Silently ignored if the ID is provided as path parameter of the request.

publicIdstring · min: 1 · max: 260Optional

The new public id for the Asset Type. It must be unique within all Asset Types, Complex Relation Types, Domain Types and Scopes. It should contain only ASCII letters and digits. It must start with an uppercase ASCII character. It must end with "_C". WARNING : The public id should only be changed with extreme caution, since it can break existing customizations. The only valid use case is to change it after creation of the type, if no public id was specified, and the generated proposal is not acceptable.

namestring · min: 1 · max: 255Optional

The new name for the Asset Type.

descriptionstring · max: 4000Optional

The new description for the Asset Type.

parentIdstring · uuidOptional

The ID of the new parent for the Asset Type.

colorstring · max: 7Optional

The color of the symbol, in a hex format e.g. '#000000'. This format always includes the '#' and has a size of 7.

Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$

symbolTypestring · enumOptional

The symbol type.

Possible values:

iconCodestringOptional

The icon code, a code representing the icon that should be shown.

acronymCodestringOptional

The acronym code, a code representing the acronym that should be shown.

Pattern: ^([A-Za-z0-9]{1,4})$

displayNameEnabledbooleanOptional

Whether display name should be enabled for all Assets of changed type.

ratingEnabledbooleanOptional

Whether rating should be enabled for all Assets of given type.

traitIdsstring · uuid[]Optional

The complete list of Traits to be applied to the Asset Type. This replaces all previously applied Traits.Please keep in mind that system-applied Traits can not be removed.

Responses

200

Asset types changed

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

publicIdstringOptional

The public id of the asset type.

Example: "TechnicalReport_C"

displayNameEnabledbooleanOptional

ratingEnabledbooleanOptional

finalTypebooleanOptional

Whether the ability to create child asset types and scoped assignments for this asset type is locked.

lockStatusesbooleanOptional

Whether the ability to add custom statuses to the assignments of this asset type is locked.

productstringOptional

The product to which this asset type is linked.

patch/assetTypes/bulk

PATCH /rest/2.0/assetTypes/bulk HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 323

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "publicId": "text",
    "name": "text",
    "description": "text",
    "parentId": "123e4567-e89b-12d3-a456-426614174000",
    "color": "text",
    "symbolType": "NONE",
    "iconCode": "text",
    "acronymCode": "text",
    "displayNameEnabled": true,
    "ratingEnabled": true,
    "traitIds": [
      "123e4567-e89b-12d3-a456-426614174000"
    ]
  }
]

200

Asset types changed

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "name": "Test name",
    "description": "Sample descripion of the resource.",
    "publicId": "\"TechnicalReport_C\"",
    "parent": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    },
    "symbolData": {
      "color": "text",
      "symbolType": "NONE",
      "iconCode": "text",
      "acronymCode": "text"
    },
    "displayNameEnabled": true,
    "ratingEnabled": true,
    "finalType": true,
    "lockStatuses": true,
    "product": "text",
    "appliedTraits": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "trait": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        },
        "system": true
      }
    ]
  }
]

Get asset type by ID

get

Returns the asset type having the given ID.

Authorizations

AuthorizationstringRequired

Path parameters

assetTypeIdstring · uuidRequired

The ID of the asset type

Responses

200

Asset type found

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

publicIdstringOptional

The public id of the asset type.

Example: "TechnicalReport_C"

displayNameEnabledbooleanOptional

ratingEnabledbooleanOptional

finalTypebooleanOptional

Whether the ability to create child asset types and scoped assignments for this asset type is locked.

lockStatusesbooleanOptional

Whether the ability to add custom statuses to the assignments of this asset type is locked.

productstringOptional

The product to which this asset type is linked.

404

Asset type not found

get/assetTypes/{assetTypeId}

GET /rest/2.0/assetTypes/{assetTypeId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "description": "Sample descripion of the resource.",
  "publicId": "\"TechnicalReport_C\"",
  "parent": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "symbolData": {
    "color": "text",
    "symbolType": "NONE",
    "iconCode": "text",
    "acronymCode": "text"
  },
  "displayNameEnabled": true,
  "ratingEnabled": true,
  "finalType": true,
  "lockStatuses": true,
  "product": "text",
  "appliedTraits": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "trait": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "system": true
    }
  ]
}

Remove asset type by ID

delete

Removes the asset type having the given ID.

Authorizations

AuthorizationstringRequired

Path parameters

assetTypeIdstring · uuidRequired

The ID of the asset type

Responses

default

default response

application/json

delete/assetTypes/{assetTypeId}

DELETE /rest/2.0/assetTypes/{assetTypeId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

default

default response

Change asset type

patch

Changes the asset type using the given parameters. Only properties that are specified in this request and have not null values are updated. All other properties are ignored.

Authorizations

AuthorizationstringRequired

Path parameters

assetTypeIdstring · uuidRequired

The ID of the asset type

Body

idstring · uuidRequired

The ID of the Asset Type to be changed. Silently ignored if the ID is provided as path parameter of the request.

publicIdstring · min: 1 · max: 260Optional

namestring · min: 1 · max: 255Optional

The new name for the Asset Type.

descriptionstring · max: 4000Optional

The new description for the Asset Type.

parentIdstring · uuidOptional

The ID of the new parent for the Asset Type.

colorstring · max: 7Optional

The color of the symbol, in a hex format e.g. '#000000'. This format always includes the '#' and has a size of 7.

Pattern: ^#([A-Fa-f0-9]{6}|[A-Fa-f0-9]{3})$

symbolTypestring · enumOptional

The symbol type.

Possible values:

iconCodestringOptional

The icon code, a code representing the icon that should be shown.

acronymCodestringOptional

The acronym code, a code representing the acronym that should be shown.

Pattern: ^([A-Za-z0-9]{1,4})$

displayNameEnabledbooleanOptional

Whether display name should be enabled for all Assets of changed type.

ratingEnabledbooleanOptional

Whether rating should be enabled for all Assets of given type.

traitIdsstring · uuid[]Optional

The complete list of Traits to be applied to the Asset Type. This replaces all previously applied Traits.Please keep in mind that system-applied Traits can not be removed.

Responses

200

Asset type changed

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

publicIdstringOptional

The public id of the asset type.

Example: "TechnicalReport_C"

displayNameEnabledbooleanOptional

ratingEnabledbooleanOptional

finalTypebooleanOptional

Whether the ability to create child asset types and scoped assignments for this asset type is locked.

lockStatusesbooleanOptional

Whether the ability to add custom statuses to the assignments of this asset type is locked.

productstringOptional

The product to which this asset type is linked.

patch/assetTypes/{assetTypeId}

PATCH /rest/2.0/assetTypes/{assetTypeId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 321

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "publicId": "text",
  "name": "text",
  "description": "text",
  "parentId": "123e4567-e89b-12d3-a456-426614174000",
  "color": "text",
  "symbolType": "NONE",
  "iconCode": "text",
  "acronymCode": "text",
  "displayNameEnabled": true,
  "ratingEnabled": true,
  "traitIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

200

Asset type changed

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "description": "Sample descripion of the resource.",
  "publicId": "\"TechnicalReport_C\"",
  "parent": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "symbolData": {
    "color": "text",
    "symbolType": "NONE",
    "iconCode": "text",
    "acronymCode": "text"
  },
  "displayNameEnabled": true,
  "ratingEnabled": true,
  "finalType": true,
  "lockStatuses": true,
  "product": "text",
  "appliedTraits": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "trait": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "system": true
    }
  ]
}

Find parent types

get

Finds all the parent asset types of the asset with the given ID.

Authorizations

AuthorizationstringRequired

Path parameters

assetTypeIdstring · uuidRequired

The unique identifier of the AssetType.

Responses

200

Parent asset types found

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

publicIdstringOptional

The public id of the asset type.

Example: "TechnicalReport_C"

displayNameEnabledbooleanOptional

ratingEnabledbooleanOptional

finalTypebooleanOptional

Whether the ability to create child asset types and scoped assignments for this asset type is locked.

lockStatusesbooleanOptional

Whether the ability to add custom statuses to the assignments of this asset type is locked.

productstringOptional

The product to which this asset type is linked.

get/assetTypes/{assetTypeId}/parents

GET /rest/2.0/assetTypes/{assetTypeId}/parents HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

Parent asset types found

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174000",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "createdOn": 1475503010320,
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "lastModifiedOn": 1476703764163,
    "system": true,
    "name": "Test name",
    "description": "Sample descripion of the resource.",
    "publicId": "\"TechnicalReport_C\"",
    "parent": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    },
    "symbolData": {
      "color": "text",
      "symbolType": "NONE",
      "iconCode": "text",
      "acronymCode": "text"
    },
    "displayNameEnabled": true,
    "ratingEnabled": true,
    "finalType": true,
    "lockStatuses": true,
    "product": "text",
    "appliedTraits": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "trait": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        },
        "system": true
      }
    ]
  }
]

Find asset subtypes

get

Finds all asset subtypes of an asset type, as specified by the request parameters.

Authorizations

AuthorizationstringRequired

Path parameters

assetTypeIdstring · uuidRequired

The ID of the AssetType

Query parameters

includeParentbooleanOptional

Whether parent Asset Type should be included in the search result.

directSubTypesOnlybooleanOptional

Whether we should only list the direct subtypes, or all subtypes.

Responses

200

Asset types found

application/json

totalinteger · int64Optional

The total number of results.

Example: 1000

offsetinteger · int64Optional

The offset for the results.

Example: 10

limitinteger · int64Optional

The maximum number of results to be returned.

Example: 100

get/assetTypes/{assetTypeId}/subTypes

GET /rest/2.0/assetTypes/{assetTypeId}/subTypes HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

Asset types found

{
  "total": 1000,
  "offset": 10,
  "limit": 100,
  "results": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "name": "Test name",
      "description": "Sample descripion of the resource.",
      "publicId": "\"TechnicalReport_C\"",
      "parent": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "symbolData": {
        "color": "text",
        "symbolType": "NONE",
        "iconCode": "text",
        "acronymCode": "text"
      },
      "displayNameEnabled": true,
      "ratingEnabled": true,
      "finalType": true,
      "lockStatuses": true,
      "product": "text",
      "appliedTraits": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "trait": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          },
          "system": true
        }
      ]
    }
  ]
}

Get the asset type by public id

get

Returns the asset type identified by the given public id.

Authorizations

AuthorizationstringRequired

Path parameters

publicIdstringRequired

The public identifier of the asset type

Responses

200

Asset type found

application/json

idstring · uuidRequired

The id of the represented object (entity).

createdBystring · uuidOptional

The id of the user that created this resource.

Example: 4d250cc5-e583-4640-9874-b93d82c7a6cb

createdOninteger · int64Optional

The timestamp (in UTC time standard) of the creation of this resource.

Example: 1475503010320

lastModifiedBystring · uuidOptional

The id of the user who modified this resource the last time.

Example: a073ff90-e7bc-4b35-ba90-c4d475f642fe

lastModifiedOninteger · int64Optional

The timestamp (in UTC time standard) of the last modification of this resource.

Example: 1476703764163

systembooleanOptional

Whether this is a system resource or not.

resourceTypestring · enumRequiredDeprecated

Possible values:

namestringOptional

The name of the resource.

Example: Test name

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

publicIdstringOptional

The public id of the asset type.

Example: "TechnicalReport_C"

displayNameEnabledbooleanOptional

ratingEnabledbooleanOptional

finalTypebooleanOptional

Whether the ability to create child asset types and scoped assignments for this asset type is locked.

lockStatusesbooleanOptional

Whether the ability to add custom statuses to the assignments of this asset type is locked.

productstringOptional

The product to which this asset type is linked.

404

Asset type not found

get/assetTypes/publicId/{publicId}

GET /rest/2.0/assetTypes/publicId/{publicId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "name": "Test name",
  "description": "Sample descripion of the resource.",
  "publicId": "\"TechnicalReport_C\"",
  "parent": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "symbolData": {
    "color": "text",
    "symbolType": "NONE",
    "iconCode": "text",
    "acronymCode": "text"
  },
  "displayNameEnabled": true,
  "ratingEnabled": true,
  "finalType": true,
  "lockStatuses": true,
  "product": "text",
  "appliedTraits": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "trait": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "system": true
    }
  ]
}

PreviousMappings NextAttribute Types

Last updated 22 days ago

Was this helpful?