Assignments

Adds a new Assignment.

post

Adds a new Assignment.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Body

application/json

idstring · uuidOptional

The ID of the new assignment. Should be unique within all assignments.
It should have a format of universally unique identifier (UUID) and should not start with 00000000-0000-0000- which is a reserved prefix.

assetTypeIdstring · uuidRequired

The ID of the asset type corresponding to the assignment

statusIdsstring · uuid[] · min: 1 · max: 2147483647Required

The list of IDs of the statuses. The first element in the list is used as default status id.

validationRuleIdsstring · uuid[]Optional

The list of IDs of the validation rules

dataQualityRuleIdsstring · uuid[]Optional

The list of IDs of the data quality rules

domainTypeIdsstring · uuid[]Optional

The list of IDs of the domain types

defaultStatusIdstring · uuidOptionalDeprecated

The ID of the default status for the asset type. Deprecated : this property is ignored. The default status is the first status in the list of assigned statuses of the assignment.

scopeIdstring · uuidOptional

The ID of the scope the assignment corresponds to

Responses

201

Assignment 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:

defaultStatusIdstring · uuidOptionalDeprecated

The ID of the default status. Deprecated : this property is ignored. The default status is the first status in the list of assigned statuses of the assignment.

Example: 00000000-0000-0000-0000-000000005009

400

An assignment with the given ID already exists

post/assignments

HTTPcURLJavaScriptPython

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

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "assetTypeId": "123e4567-e89b-12d3-a456-426614174000",
  "statusIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "characteristicTypes": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "min": 1,
      "max": 1,
      "readOnly": true,
      "resourceDiscriminator": "text",
      "relationTypeDirection": "TO_SOURCE",
      "relationTypeRestriction": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "articulationRules": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "ADD",
      "score": 1,
      "statusId": "123e4567-e89b-12d3-a456-426614174000",
      "attributeTypeId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "validationRuleIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "dataQualityRuleIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "domainTypeIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "scopeId": "123e4567-e89b-12d3-a456-426614174000"
}

{
  "id": "123e4567-e89b-12d3-a456-426614174000",
  "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
  "createdOn": 1475503010320,
  "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
  "lastModifiedOn": 1476703764163,
  "system": true,
  "assetType": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "statuses": [
    {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text",
      "description": "This is the description of the resource"
    }
  ],
  "assignedCharacteristicTypeReferences": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "assignedResourceReference": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "assignedResourcePublicId": "text",
      "minimumOccurrences": 1,
      "maximumOccurrences": 1,
      "system": true,
      "readOnly": true,
      "relationTypeDirection": "TO_SOURCE",
      "relationTypeRestriction": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "matchingLegTypesIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "articulationRules": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "score": 1,
      "operation": "ADD",
      "status": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "attributeType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    }
  ],
  "validationRules": [
    {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    }
  ],
  "dataQualityRules": [
    {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text",
      "description": "This is the description of the resource"
    }
  ],
  "domainTypes": [
    {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text",
      "description": "This is the description of the resource"
    }
  ],
  "scope": {
    "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": "\"Finance_C\"",
    "domains": [
      {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    ],
    "communities": [
      {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    ]
  },
  "assignmentInheritances": [
    {
      "assetType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "traitAssignmentInheritances": [
        {
          "trait": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          },
          "assetType": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          },
          "characteristicTypes": [
            {
              "minimumOccurrences": 1,
              "maximumOccurrences": 1,
              "assignedResourceId": "123e4567-e89b-12d3-a456-426614174000",
              "assignedCharacteristicTypeDiscriminator": "text",
              "readOnly": true,
              "system": true,
              "id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "assignedCharacteristicTypeReferences": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "assignedResourceReference": {
                "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
                "resourceDiscriminator": "Community",
                "name": "text"
              },
              "assignedResourcePublicId": "text",
              "minimumOccurrences": 1,
              "maximumOccurrences": 1,
              "system": true,
              "readOnly": true,
              "relationTypeDirection": "TO_SOURCE",
              "relationTypeRestriction": {
                "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
                "resourceDiscriminator": "Community",
                "name": "text"
              },
              "matchingLegTypesIds": [
                "123e4567-e89b-12d3-a456-426614174000"
              ]
            }
          ],
          "traitAssignment": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community"
          },
          "scope": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          }
        }
      ],
      "assignment": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community"
      },
      "scope": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    }
  ],
  "traitAssignmentInheritances": [
    {
      "trait": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "assetType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "characteristicTypes": [
        {
          "minimumOccurrences": 1,
          "maximumOccurrences": 1,
          "assignedResourceId": "123e4567-e89b-12d3-a456-426614174000",
          "assignedCharacteristicTypeDiscriminator": "text",
          "readOnly": true,
          "system": true,
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "assignedCharacteristicTypeReferences": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "assignedResourceReference": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          },
          "assignedResourcePublicId": "text",
          "minimumOccurrences": 1,
          "maximumOccurrences": 1,
          "system": true,
          "readOnly": true,
          "relationTypeDirection": "TO_SOURCE",
          "relationTypeRestriction": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          },
          "matchingLegTypesIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "traitAssignment": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community"
      },
      "scope": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    }
  ]
}

Removes the Assignment identified by the given id.

delete

Removes the Assignment identified by the given id.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

assignmentIdstring · uuidRequired

The unique identifier of the Assignment.

Responses

200

Assignment removed.

No content

404

Assignment not found.

delete/assignments/{assignmentId}

HTTPcURLJavaScriptPython

DELETE /rest/2.0/assignments/{assignmentId} HTTP/1.1
Authorization: Basic username:password
Accept: */*

No content

Changes the assignment with the information that is provided in the request.

patch

Changes the assignment with the information that is provided in the request. Only properties that are specified in the request and are not NULL are updated. All other properties are ignored.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

assignmentIdstring · uuidRequired

The unique identifier of the Assignment.

Body

application/json

statusIdsstring · uuid[]Optional

The list of IDs of the statuses. The first element in the list is used as default status id.

validationRuleIdsstring · uuid[]Optional

The list of IDs of the validation rules

dataQualityRuleIdsstring · uuid[]Optional

The list of IDs of the data quality rules

domainTypeIdsstring · uuid[]Optional

The list of IDs of the domain types

defaultStatusIdstring · uuidOptionalDeprecated

The ID of the default status for the asset type. Deprecated : this property is ignored. The default status is the first status in the list of assigned statuses of the assignment.

scopeIdstring · uuidOptionalDeprecated

The ID of the scope the assignment corresponds to. The scopeId is ignored, and will be removed in the future.

Responses

200

Assignment successfully 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

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:

defaultStatusIdstring · uuidOptionalDeprecated

The ID of the default status. Deprecated : this property is ignored. The default status is the first status in the list of assigned statuses of the assignment.

Example: 00000000-0000-0000-0000-000000005009

patch/assignments/{assignmentId}

HTTPcURLJavaScriptPython

PATCH /rest/2.0/assignments/{assignmentId} HTTP/1.1
Authorization: Basic username:password
Content-Type: application/json
Accept: */*
Content-Length: 671

{
  "statusIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "characteristicTypes": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "min": 1,
      "max": 1,
      "readOnly": true,
      "resourceDiscriminator": "text",
      "relationTypeDirection": "TO_SOURCE",
      "relationTypeRestriction": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "articulationRules": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "operation": "ADD",
      "score": 1,
      "statusId": "123e4567-e89b-12d3-a456-426614174000",
      "attributeTypeId": "123e4567-e89b-12d3-a456-426614174000"
    }
  ],
  "validationRuleIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "dataQualityRuleIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ],
  "domainTypeIds": [
    "123e4567-e89b-12d3-a456-426614174000"
  ]
}

200

Assignment successfully 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,
  "assetType": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "statuses": [
    {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text",
      "description": "This is the description of the resource"
    }
  ],
  "assignedCharacteristicTypeReferences": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "assignedResourceReference": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "assignedResourcePublicId": "text",
      "minimumOccurrences": 1,
      "maximumOccurrences": 1,
      "system": true,
      "readOnly": true,
      "relationTypeDirection": "TO_SOURCE",
      "relationTypeRestriction": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "matchingLegTypesIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "articulationRules": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "score": 1,
      "operation": "ADD",
      "status": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "attributeType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    }
  ],
  "validationRules": [
    {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    }
  ],
  "dataQualityRules": [
    {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text",
      "description": "This is the description of the resource"
    }
  ],
  "domainTypes": [
    {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text",
      "description": "This is the description of the resource"
    }
  ],
  "scope": {
    "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": "\"Finance_C\"",
    "domains": [
      {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    ],
    "communities": [
      {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    ]
  },
  "assignmentInheritances": [
    {
      "assetType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "traitAssignmentInheritances": [
        {
          "trait": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          },
          "assetType": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          },
          "characteristicTypes": [
            {
              "minimumOccurrences": 1,
              "maximumOccurrences": 1,
              "assignedResourceId": "123e4567-e89b-12d3-a456-426614174000",
              "assignedCharacteristicTypeDiscriminator": "text",
              "readOnly": true,
              "system": true,
              "id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "assignedCharacteristicTypeReferences": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "assignedResourceReference": {
                "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
                "resourceDiscriminator": "Community",
                "name": "text"
              },
              "assignedResourcePublicId": "text",
              "minimumOccurrences": 1,
              "maximumOccurrences": 1,
              "system": true,
              "readOnly": true,
              "relationTypeDirection": "TO_SOURCE",
              "relationTypeRestriction": {
                "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
                "resourceDiscriminator": "Community",
                "name": "text"
              },
              "matchingLegTypesIds": [
                "123e4567-e89b-12d3-a456-426614174000"
              ]
            }
          ],
          "traitAssignment": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community"
          },
          "scope": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          }
        }
      ],
      "assignment": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community"
      },
      "scope": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    }
  ],
  "traitAssignmentInheritances": [
    {
      "trait": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "assetType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "characteristicTypes": [
        {
          "minimumOccurrences": 1,
          "maximumOccurrences": 1,
          "assignedResourceId": "123e4567-e89b-12d3-a456-426614174000",
          "assignedCharacteristicTypeDiscriminator": "text",
          "readOnly": true,
          "system": true,
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "assignedCharacteristicTypeReferences": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "assignedResourceReference": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          },
          "assignedResourcePublicId": "text",
          "minimumOccurrences": 1,
          "maximumOccurrences": 1,
          "system": true,
          "readOnly": true,
          "relationTypeDirection": "TO_SOURCE",
          "relationTypeRestriction": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          },
          "matchingLegTypesIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "traitAssignment": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community"
      },
      "scope": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    }
  ]
}

Find the assignments where a given resource is assigned.

get

Find the assignments where a given resource is assigned.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Query parameters

resourceIdstring · uuidOptional

The ID of the resource to which the assignment applies.

resourceTypestring · enumOptional

The type of the resource that is assigned. Deprecated in favour of resourceDiscriminator. If both are present, the value of resourceDiscriminator will be used.

Possible values:

resourceDiscriminatorstringOptional

The discriminator of the resource that is assigned.

Responses

200

Assignments 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

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:

defaultStatusIdstring · uuidOptionalDeprecated

The ID of the default status. Deprecated : this property is ignored. The default status is the first status in the list of assigned statuses of the assignment.

Example: 00000000-0000-0000-0000-000000005009

400

The parameter is invalid

get/assignments/forResource

HTTPcURLJavaScriptPython

GET /rest/2.0/assignments/forResource 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,
    "assetType": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    },
    "statuses": [
      {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text",
        "description": "This is the description of the resource"
      }
    ],
    "assignedCharacteristicTypeReferences": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "assignedResourceReference": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        },
        "assignedResourcePublicId": "text",
        "minimumOccurrences": 1,
        "maximumOccurrences": 1,
        "system": true,
        "readOnly": true,
        "relationTypeDirection": "TO_SOURCE",
        "relationTypeRestriction": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        },
        "matchingLegTypesIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ],
    "articulationRules": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "score": 1,
        "operation": "ADD",
        "status": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        },
        "attributeType": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        }
      }
    ],
    "validationRules": [
      {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    ],
    "dataQualityRules": [
      {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text",
        "description": "This is the description of the resource"
      }
    ],
    "domainTypes": [
      {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text",
        "description": "This is the description of the resource"
      }
    ],
    "scope": {
      "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": "\"Finance_C\"",
      "domains": [
        {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        }
      ],
      "communities": [
        {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        }
      ]
    },
    "assignmentInheritances": [
      {
        "assetType": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        },
        "traitAssignmentInheritances": [
          {
            "trait": {
              "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
              "resourceDiscriminator": "Community",
              "name": "text"
            },
            "assetType": {
              "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
              "resourceDiscriminator": "Community",
              "name": "text"
            },
            "characteristicTypes": [
              {
                "minimumOccurrences": 1,
                "maximumOccurrences": 1,
                "assignedResourceId": "123e4567-e89b-12d3-a456-426614174000",
                "assignedCharacteristicTypeDiscriminator": "text",
                "readOnly": true,
                "system": true,
                "id": "123e4567-e89b-12d3-a456-426614174000"
              }
            ],
            "assignedCharacteristicTypeReferences": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "assignedResourceReference": {
                  "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
                  "resourceDiscriminator": "Community",
                  "name": "text"
                },
                "assignedResourcePublicId": "text",
                "minimumOccurrences": 1,
                "maximumOccurrences": 1,
                "system": true,
                "readOnly": true,
                "relationTypeDirection": "TO_SOURCE",
                "relationTypeRestriction": {
                  "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
                  "resourceDiscriminator": "Community",
                  "name": "text"
                },
                "matchingLegTypesIds": [
                  "123e4567-e89b-12d3-a456-426614174000"
                ]
              }
            ],
            "traitAssignment": {
              "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
              "resourceDiscriminator": "Community"
            },
            "scope": {
              "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
              "resourceDiscriminator": "Community",
              "name": "text"
            }
          }
        ],
        "assignment": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community"
        },
        "scope": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        }
      }
    ],
    "traitAssignmentInheritances": [
      {
        "trait": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        },
        "assetType": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        },
        "characteristicTypes": [
          {
            "minimumOccurrences": 1,
            "maximumOccurrences": 1,
            "assignedResourceId": "123e4567-e89b-12d3-a456-426614174000",
            "assignedCharacteristicTypeDiscriminator": "text",
            "readOnly": true,
            "system": true,
            "id": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "assignedCharacteristicTypeReferences": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "assignedResourceReference": {
              "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
              "resourceDiscriminator": "Community",
              "name": "text"
            },
            "assignedResourcePublicId": "text",
            "minimumOccurrences": 1,
            "maximumOccurrences": 1,
            "system": true,
            "readOnly": true,
            "relationTypeDirection": "TO_SOURCE",
            "relationTypeRestriction": {
              "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
              "resourceDiscriminator": "Community",
              "name": "text"
            },
            "matchingLegTypesIds": [
              "123e4567-e89b-12d3-a456-426614174000"
            ]
          }
        ],
        "traitAssignment": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community"
        },
        "scope": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        }
      }
    ]
  }
]

Returns the Assignment identified by the given Asset.

get

Returns the Assignment identified by the given Asset.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

assetIdstring · uuidRequired

The unique identifier of the Asset.

Responses

200

Assignment 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

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:

defaultStatusIdstring · uuidOptionalDeprecated

The ID of the default status. Deprecated : this property is ignored. The default status is the first status in the list of assigned statuses of the assignment.

Example: 00000000-0000-0000-0000-000000005009

404

Assignment not found.

get/assignments/asset/{assetId}

HTTPcURLJavaScriptPython

GET /rest/2.0/assignments/asset/{assetId} 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,
  "assetType": {
    "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
    "resourceDiscriminator": "Community",
    "name": "text"
  },
  "statuses": [
    {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text",
      "description": "This is the description of the resource"
    }
  ],
  "assignedCharacteristicTypeReferences": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "assignedResourceReference": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "assignedResourcePublicId": "text",
      "minimumOccurrences": 1,
      "maximumOccurrences": 1,
      "system": true,
      "readOnly": true,
      "relationTypeDirection": "TO_SOURCE",
      "relationTypeRestriction": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "matchingLegTypesIds": [
        "123e4567-e89b-12d3-a456-426614174000"
      ]
    }
  ],
  "articulationRules": [
    {
      "id": "123e4567-e89b-12d3-a456-426614174000",
      "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
      "createdOn": 1475503010320,
      "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
      "lastModifiedOn": 1476703764163,
      "system": true,
      "score": 1,
      "operation": "ADD",
      "status": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "attributeType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    }
  ],
  "validationRules": [
    {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    }
  ],
  "dataQualityRules": [
    {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text",
      "description": "This is the description of the resource"
    }
  ],
  "domainTypes": [
    {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text",
      "description": "This is the description of the resource"
    }
  ],
  "scope": {
    "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": "\"Finance_C\"",
    "domains": [
      {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    ],
    "communities": [
      {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    ]
  },
  "assignmentInheritances": [
    {
      "assetType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "traitAssignmentInheritances": [
        {
          "trait": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          },
          "assetType": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          },
          "characteristicTypes": [
            {
              "minimumOccurrences": 1,
              "maximumOccurrences": 1,
              "assignedResourceId": "123e4567-e89b-12d3-a456-426614174000",
              "assignedCharacteristicTypeDiscriminator": "text",
              "readOnly": true,
              "system": true,
              "id": "123e4567-e89b-12d3-a456-426614174000"
            }
          ],
          "assignedCharacteristicTypeReferences": [
            {
              "id": "123e4567-e89b-12d3-a456-426614174000",
              "assignedResourceReference": {
                "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
                "resourceDiscriminator": "Community",
                "name": "text"
              },
              "assignedResourcePublicId": "text",
              "minimumOccurrences": 1,
              "maximumOccurrences": 1,
              "system": true,
              "readOnly": true,
              "relationTypeDirection": "TO_SOURCE",
              "relationTypeRestriction": {
                "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
                "resourceDiscriminator": "Community",
                "name": "text"
              },
              "matchingLegTypesIds": [
                "123e4567-e89b-12d3-a456-426614174000"
              ]
            }
          ],
          "traitAssignment": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community"
          },
          "scope": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          }
        }
      ],
      "assignment": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community"
      },
      "scope": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    }
  ],
  "traitAssignmentInheritances": [
    {
      "trait": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "assetType": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      },
      "characteristicTypes": [
        {
          "minimumOccurrences": 1,
          "maximumOccurrences": 1,
          "assignedResourceId": "123e4567-e89b-12d3-a456-426614174000",
          "assignedCharacteristicTypeDiscriminator": "text",
          "readOnly": true,
          "system": true,
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      ],
      "assignedCharacteristicTypeReferences": [
        {
          "id": "123e4567-e89b-12d3-a456-426614174000",
          "assignedResourceReference": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          },
          "assignedResourcePublicId": "text",
          "minimumOccurrences": 1,
          "maximumOccurrences": 1,
          "system": true,
          "readOnly": true,
          "relationTypeDirection": "TO_SOURCE",
          "relationTypeRestriction": {
            "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
            "resourceDiscriminator": "Community",
            "name": "text"
          },
          "matchingLegTypesIds": [
            "123e4567-e89b-12d3-a456-426614174000"
          ]
        }
      ],
      "traitAssignment": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community"
      },
      "scope": {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    }
  ]
}

Returns Assignments for given asset type id.

get

Returns Assignments for given asset type id.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

assetTypeIdstring · uuidRequired

The unique identifier of the AssetType.

Responses

200

Assignments 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

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:

defaultStatusIdstring · uuidOptionalDeprecated

The ID of the default status. Deprecated : this property is ignored. The default status is the first status in the list of assigned statuses of the assignment.

Example: 00000000-0000-0000-0000-000000005009

get/assignments/assetType/{assetTypeId}

HTTPcURLJavaScriptPython

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

200

Assignments 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,
    "assetType": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text"
    },
    "statuses": [
      {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text",
        "description": "This is the description of the resource"
      }
    ],
    "assignedCharacteristicTypeReferences": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "assignedResourceReference": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        },
        "assignedResourcePublicId": "text",
        "minimumOccurrences": 1,
        "maximumOccurrences": 1,
        "system": true,
        "readOnly": true,
        "relationTypeDirection": "TO_SOURCE",
        "relationTypeRestriction": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        },
        "matchingLegTypesIds": [
          "123e4567-e89b-12d3-a456-426614174000"
        ]
      }
    ],
    "articulationRules": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "score": 1,
        "operation": "ADD",
        "status": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        },
        "attributeType": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        }
      }
    ],
    "validationRules": [
      {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text"
      }
    ],
    "dataQualityRules": [
      {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text",
        "description": "This is the description of the resource"
      }
    ],
    "domainTypes": [
      {
        "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
        "resourceDiscriminator": "Community",
        "name": "text",
        "description": "This is the description of the resource"
      }
    ],
    "scope": {
      "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": "\"Finance_C\"",
      "domains": [
        {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        }
      ],
      "communities": [
        {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        }
      ]
    },
    "assignmentInheritances": [
      {
        "assetType": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        },
        "traitAssignmentInheritances": [
          {
            "trait": {
              "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
              "resourceDiscriminator": "Community",
              "name": "text"
            },
            "assetType": {
              "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
              "resourceDiscriminator": "Community",
              "name": "text"
            },
            "characteristicTypes": [
              {
                "minimumOccurrences": 1,
                "maximumOccurrences": 1,
                "assignedResourceId": "123e4567-e89b-12d3-a456-426614174000",
                "assignedCharacteristicTypeDiscriminator": "text",
                "readOnly": true,
                "system": true,
                "id": "123e4567-e89b-12d3-a456-426614174000"
              }
            ],
            "assignedCharacteristicTypeReferences": [
              {
                "id": "123e4567-e89b-12d3-a456-426614174000",
                "assignedResourceReference": {
                  "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
                  "resourceDiscriminator": "Community",
                  "name": "text"
                },
                "assignedResourcePublicId": "text",
                "minimumOccurrences": 1,
                "maximumOccurrences": 1,
                "system": true,
                "readOnly": true,
                "relationTypeDirection": "TO_SOURCE",
                "relationTypeRestriction": {
                  "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
                  "resourceDiscriminator": "Community",
                  "name": "text"
                },
                "matchingLegTypesIds": [
                  "123e4567-e89b-12d3-a456-426614174000"
                ]
              }
            ],
            "traitAssignment": {
              "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
              "resourceDiscriminator": "Community"
            },
            "scope": {
              "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
              "resourceDiscriminator": "Community",
              "name": "text"
            }
          }
        ],
        "assignment": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community"
        },
        "scope": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        }
      }
    ],
    "traitAssignmentInheritances": [
      {
        "trait": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        },
        "assetType": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        },
        "characteristicTypes": [
          {
            "minimumOccurrences": 1,
            "maximumOccurrences": 1,
            "assignedResourceId": "123e4567-e89b-12d3-a456-426614174000",
            "assignedCharacteristicTypeDiscriminator": "text",
            "readOnly": true,
            "system": true,
            "id": "123e4567-e89b-12d3-a456-426614174000"
          }
        ],
        "assignedCharacteristicTypeReferences": [
          {
            "id": "123e4567-e89b-12d3-a456-426614174000",
            "assignedResourceReference": {
              "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
              "resourceDiscriminator": "Community",
              "name": "text"
            },
            "assignedResourcePublicId": "text",
            "minimumOccurrences": 1,
            "maximumOccurrences": 1,
            "system": true,
            "readOnly": true,
            "relationTypeDirection": "TO_SOURCE",
            "relationTypeRestriction": {
              "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
              "resourceDiscriminator": "Community",
              "name": "text"
            },
            "matchingLegTypesIds": [
              "123e4567-e89b-12d3-a456-426614174000"
            ]
          }
        ],
        "traitAssignment": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community"
        },
        "scope": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        }
      }
    ]
  }
]

Returns available asset types for domain identified by given id.

get

Returns available asset types for domain identified by given id.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

domainIdstring · uuidRequired

The unique identifier of the Domain.

Responses

200

AssetTypes 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

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.

get/assignments/domain/{domainId}/assetTypes

HTTPcURLJavaScriptPython

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

200

AssetTypes 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
      }
    ]
  }
]

Returns available attribute types for asset identified by given id.

get

Returns available attribute types for asset identified by given id.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

assetIdstring · uuidRequired

The unique identifier of the Asset.

Responses

200

AttributeTypes found.

application/json

attributeTypeDiscriminatorstringOptional

the discriminator of this AttributeType, which indicates the type. The value can be one of : BooleanAttributeType, DateAttributeType, MultiValueListAttributeType, NumericAttributeType, ScriptAttributeType, SingleValueListAttributeType or StringAttributeType.

publicIdstringOptional

The public id of the attribute type.

Example: "ApprovalDate_C"

descriptionstringOptional

The description of the resource.

Example: Sample descripion of the resource.

namestringOptional

The name of the resource.

Example: Test name

resourceTypestring · enumOptionalDeprecated

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:

createdBystring · uuidOptional

The id of the user that created this resource.

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

lastModifiedBystring · uuidOptional

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

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

createdOninteger · int64Optional

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

Example: 1475503010320

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.

idstring · uuidOptional

The id of the represented object (entity).

get/assignments/asset/{assetId}/attributeTypes

HTTPcURLJavaScriptPython

GET /rest/2.0/assignments/asset/{assetId}/attributeTypes HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

AttributeTypes found.

[
  {
    "attributeTypeDiscriminator": "text",
    "publicId": "\"ApprovalDate_C\"",
    "description": "Sample descripion of the resource.",
    "name": "Test name",
    "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
    "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
    "createdOn": 1475503010320,
    "lastModifiedOn": 1476703764163,
    "system": true,
    "id": "123e4567-e89b-12d3-a456-426614174000"
  }
]

Returns the available ComplexRelationTypes for the Asset identified by the given id.

get

Returns the available ComplexRelationTypes for the Asset identified by the given id.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

assetIdstring · uuidRequired

The unique identifier of the Asset.

Responses

200

ComplexRelationTypes 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

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 complex relation type.

Example: "ReportCollection_C"

get/assignments/asset/{assetId}/complexRelationTypes

HTTPcURLJavaScriptPython

GET /rest/2.0/assignments/asset/{assetId}/complexRelationTypes HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

ComplexRelationTypes 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": "\"ReportCollection_C\"",
    "symbolData": {
      "color": "text",
      "symbolType": "NONE",
      "iconCode": "text",
      "acronymCode": "text"
    },
    "attributeTypes": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "minimumOccurrences": 1,
        "maximumOccurrences": 1,
        "readOnly": true,
        "attributeType": {
          "attributeTypeDiscriminator": "text",
          "publicId": "\"ApprovalDate_C\"",
          "description": "Sample descripion of the resource.",
          "name": "Test name",
          "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
          "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
          "createdOn": 1475503010320,
          "lastModifiedOn": 1476703764163,
          "system": true,
          "id": "123e4567-e89b-12d3-a456-426614174000"
        }
      }
    ],
    "legTypes": [
      {
        "id": "123e4567-e89b-12d3-a456-426614174000",
        "createdBy": "4d250cc5-e583-4640-9874-b93d82c7a6cb",
        "createdOn": 1475503010320,
        "lastModifiedBy": "a073ff90-e7bc-4b35-ba90-c4d475f642fe",
        "lastModifiedOn": 1476703764163,
        "system": true,
        "minimumOccurrences": 1,
        "maximumOccurrences": 1,
        "assetType": {
          "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
          "resourceDiscriminator": "Community",
          "name": "text"
        },
        "role": "text",
        "coRole": "text",
        "relationTypeId": "123e4567-e89b-12d3-a456-426614174000"
      }
    ]
  }
]

Returns the available RelationTypes for the Asset identified by the given id.

get

Returns the available RelationTypes for the Asset identified by the given id.

Authorizations

basicAuthjwtAuthoauth2

AuthorizationstringRequired

Path parameters

assetIdstring · uuidRequired

The unique identifier of the Asset.

Responses

200

RelationTypes 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

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:

publicIdstringOptional

The public id of the relation type.

Example: "TechnicalReportIsWrittenByAuthor_C"

rolestringOptional

The name of the role that source plays in the relation.

coRolestringOptional

The name of the role that target plays in the relation.

descriptionstringOptional

The description of the relation type.

get/assignments/asset/{assetId}/relationTypes

HTTPcURLJavaScriptPython

GET /rest/2.0/assignments/asset/{assetId}/relationTypes HTTP/1.1
Authorization: Basic username:password
Accept: */*

200

RelationTypes 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,
    "publicId": "\"TechnicalReportIsWrittenByAuthor_C\"",
    "sourceType": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text",
      "publicId": "text"
    },
    "targetType": {
      "id": "2b7f3a1a-4e50-4077-96f0-a58a395c860d",
      "resourceDiscriminator": "Community",
      "name": "text",
      "publicId": "text"
    },
    "role": "text",
    "coRole": "text",
    "description": "text"
  }
]