Get the Type Definition and All Its Relationships
get/definitions/{definitionId}/relationships
Returns an archive of the entity or classification type definition itself, along with all the relationships related to it, including the inherited ones, and separate them into lists by the kind of type definition. Note that the archive media type must be specified in order to generate an archive response.
1{2 "entityTypeDefinitions": [3 {4 "creationTimeStamp": "0001-01-01T00:00:00Z",5 "modifiedTimeStamp": "2023-06-29T00:00:00Z",6 "id": "dcdc0b06-91b2-4a69-8754-359539495e10",7 "links": [8 {9 "method": "GET",10 "rel": "self",11 "href": "/catalog/definitions/dcdc0b06-91b2-4a69-8754-359539495e10",12 "uri": "/catalog/definitions/dcdc0b06-91b2-4a69-8754-359539495e10",13 "type": "application/vnd.sas.metadata.definition.entity"14 },15 {16 "method": "GET",17 "rel": "alternate",18 "href": "/catalog/definitions/dcdc0b06-91b2-4a69-8754-359539495e10",19 "uri": "/catalog/definitions/dcdc0b06-91b2-4a69-8754-359539495e10",20 "type": "application/vnd.sas.metadata.definition.summary"21 },22 {23 "method": "PUT",24 "rel": "update",25 "href": "/catalog/definitions/dcdc0b06-91b2-4a69-8754-359539495e10",26 "uri": "/catalog/definitions/dcdc0b06-91b2-4a69-8754-359539495e10",27 "type": "application/vnd.sas.metadata.definition.entity",28 "responseType": "application/vnd.sas.metadata.definition.entity"29 },30 {31 "method": "DELETE",32 "rel": "delete",33 "href": "/catalog/definitions/dcdc0b06-91b2-4a69-8754-359539495e10",34 "uri": "/catalog/definitions/dcdc0b06-91b2-4a69-8754-359539495e10"35 },36 {37 "method": "GET",38 "rel": "up",39 "href": "/catalog/definitions",40 "uri": "/catalog/definitions",41 "type": "application/vnd.sas.collection",42 "itemType": "application/vnd.sas.metadata.definition.summary"43 }44 ],45 "version": 2,46 "definitionType": "entity",47 "name": "folder",48 "label": "Folder",49 "description": "Container for assets in a tree structure for organization.",50 "i18nSource": "catalog-gui-icu",51 "baseType": "base",52 "platformTypeName": "folder",53 "metaCategory": "PRIMARY"54 }55 ],56 "relationshipTypeDefinitions": [57 {58 "creationTimeStamp": "0001-01-01T00:00:00Z",59 "modifiedTimeStamp": "2023-06-29T00:00:00Z",60 "id": "e57cbb84-84a5-4a6c-ac44-ffb7a87339cc",61 "links": [62 {63 "method": "GET",64 "rel": "self",65 "href": "/catalog/definitions/e57cbb84-84a5-4a6c-ac44-ffb7a87339cc",66 "uri": "/catalog/definitions/e57cbb84-84a5-4a6c-ac44-ffb7a87339cc",67 "type": "application/vnd.sas.metadata.definition.relationship"68 },69 {70 "method": "GET",71 "rel": "alternate",72 "href": "/catalog/definitions/e57cbb84-84a5-4a6c-ac44-ffb7a87339cc",73 "uri": "/catalog/definitions/e57cbb84-84a5-4a6c-ac44-ffb7a87339cc",74 "type": "application/vnd.sas.metadata.definition.summary"75 },76 {77 "method": "PUT",78 "rel": "update",79 "href": "/catalog/definitions/e57cbb84-84a5-4a6c-ac44-ffb7a87339cc",80 "uri": "/catalog/definitions/e57cbb84-84a5-4a6c-ac44-ffb7a87339cc",81 "type": "application/vnd.sas.metadata.definition.relationship",82 "responseType": "application/vnd.sas.metadata.definition.relationship"83 },84 {85 "method": "DELETE",86 "rel": "delete",87 "href": "/catalog/definitions/e57cbb84-84a5-4a6c-ac44-ffb7a87339cc",88 "uri": "/catalog/definitions/e57cbb84-84a5-4a6c-ac44-ffb7a87339cc"89 },90 {91 "method": "GET",92 "rel": "up",93 "href": "/catalog/definitions",94 "uri": "/catalog/definitions",95 "type": "application/vnd.sas.collection",96 "itemType": "application/vnd.sas.metadata.definition.summary"97 }98 ],99 "version": 2,100 "definitionType": "relationship",101 "name": "folderHierarchy",102 "label": "Folder Hierarchy",103 "description": "A folder hierarchy describes the relationship between a child and its parent folder.",104 "i18nSource": "catalog-gui-icu",105 "cascadeDelete": "None",106 "role": "Associated",107 "cardinality": "ONE_TO_MANY",108 "endpointDefinition1": {109 "name": "parentFolder",110 "label": "Parent folder",111 "description": "The parent folder to the given folder.",112 "elementType": "folder",113 "container": false114 },115 "endpointDefinition2": {116 "name": "childFolder",117 "label": "Child folder",118 "description": "The child folder.",119 "elementType": "folder",120 "container": false121 }122 },123 {124 "creationTimeStamp": "0001-01-01T00:00:00Z",125 "modifiedTimeStamp": "2023-06-29T00:00:00Z",126 "id": "2eb6ed06-25b3-467b-b92e-6f18e9dd0627",127 "links": [128 {129 "method": "GET",130 "rel": "self",131 "href": "/catalog/definitions/2eb6ed06-25b3-467b-b92e-6f18e9dd0627",132 "uri": "/catalog/definitions/2eb6ed06-25b3-467b-b92e-6f18e9dd0627",133 "type": "application/vnd.sas.metadata.definition.relationship"134 },135 {136 "method": "GET",137 "rel": "alternate",138 "href": "/catalog/definitions/2eb6ed06-25b3-467b-b92e-6f18e9dd0627",139 "uri": "/catalog/definitions/2eb6ed06-25b3-467b-b92e-6f18e9dd0627",140 "type": "application/vnd.sas.metadata.definition.summary"141 },142 {143 "method": "PUT",144 "rel": "update",145 "href": "/catalog/definitions/2eb6ed06-25b3-467b-b92e-6f18e9dd0627",146 "uri": "/catalog/definitions/2eb6ed06-25b3-467b-b92e-6f18e9dd0627",147 "type": "application/vnd.sas.metadata.definition.relationship",148 "responseType": "application/vnd.sas.metadata.definition.relationship"149 },150 {151 "method": "DELETE",152 "rel": "delete",153 "href": "/catalog/definitions/2eb6ed06-25b3-467b-b92e-6f18e9dd0627",154 "uri": "/catalog/definitions/2eb6ed06-25b3-467b-b92e-6f18e9dd0627"155 },156 {157 "method": "GET",158 "rel": "up",159 "href": "/catalog/definitions",160 "uri": "/catalog/definitions",161 "type": "application/vnd.sas.collection",162 "itemType": "application/vnd.sas.metadata.definition.summary"163 }164 ],165 "version": 2,166 "definitionType": "relationship",167 "name": "itemFolder",168 "label": "Folder to contained items",169 "description": "A folder and its contained items.",170 "i18nSource": "catalog-gui-icu",171 "cascadeDelete": "None",172 "role": "Associated",173 "cardinality": "ONE_TO_MANY",174 "endpointDefinition1": {175 "name": "owningFolder",176 "label": "Owning Folder",177 "description": "The parent folder to the given item.",178 "elementType": "folder",179 "container": false180 },181 "endpointDefinition2": {182 "name": "folderItems",183 "label": "Folder items",184 "description": "Items contained within this folder.",185 "elementType": "base",186 "container": false187 }188 },189 {190 "creationTimeStamp": "0001-01-01T00:00:00Z",191 "modifiedTimeStamp": "2023-06-29T00:00:00Z",192 "id": "55212128-3647-472a-9fd0-dc19d9731c19",193 "links": [194 {195 "method": "GET",196 "rel": "self",197 "href": "/catalog/definitions/55212128-3647-472a-9fd0-dc19d9731c19",198 "uri": "/catalog/definitions/55212128-3647-472a-9fd0-dc19d9731c19",199 "type": "application/vnd.sas.metadata.definition.relationship"200 },201 {202 "method": "GET",203 "rel": "alternate",204 "href": "/catalog/definitions/55212128-3647-472a-9fd0-dc19d9731c19",205 "uri": "/catalog/definitions/55212128-3647-472a-9fd0-dc19d9731c19",206 "type": "application/vnd.sas.metadata.definition.summary"207 },208 {209 "method": "PUT",210 "rel": "update",211 "href": "/catalog/definitions/55212128-3647-472a-9fd0-dc19d9731c19",212 "uri": "/catalog/definitions/55212128-3647-472a-9fd0-dc19d9731c19",213 "type": "application/vnd.sas.metadata.definition.relationship",214 "responseType": "application/vnd.sas.metadata.definition.relationship"215 },216 {217 "method": "DELETE",218 "rel": "delete",219 "href": "/catalog/definitions/55212128-3647-472a-9fd0-dc19d9731c19",220 "uri": "/catalog/definitions/55212128-3647-472a-9fd0-dc19d9731c19"221 },222 {223 "method": "GET",224 "rel": "up",225 "href": "/catalog/definitions",226 "uri": "/catalog/definitions",227 "type": "application/vnd.sas.collection",228 "itemType": "application/vnd.sas.metadata.definition.summary"229 }230 ],231 "version": 2,232 "definitionType": "relationship",233 "name": "relatedObjects",234 "label": "Entity to related entity",235 "description": "Entity to a related entity without specific relationship knowledge.",236 "attributeDefinitions": {237 "relationshipRole": {238 "name": "relationshipRole",239 "label": "Relationship role",240 "description": "The nature of the relationship between the two assets. Used when more detail is unknown about this relationship.",241 "type": "string",242 "defaultValue": "Associated"243 },244 "source": {245 "name": "source",246 "label": "Source",247 "description": "Source URI for the relationship.",248 "type": "string"249 }250 },251 "i18nSource": "catalog-gui-icu",252 "cascadeDelete": "None",253 "role": "Associated",254 "cardinality": "MANY_TO_MANY",255 "endpointDefinition1": {256 "name": "associatedEntities",257 "label": "Associated Entities",258 "description": "Entities related to this entity.",259 "elementType": "base",260 "container": false261 },262 "endpointDefinition2": {263 "name": "relatedEntities",264 "label": "Related entities",265 "description": "Entities to which this entity is related.",266 "elementType": "base",267 "container": false268 }269 },270 {271 "creationTimeStamp": "0001-01-01T00:00:00Z",272 "modifiedTimeStamp": "2023-06-29T00:00:00Z",273 "id": "88c1652b-fafa-40d9-99b8-3abaed84a34f",274 "links": [275 {276 "method": "GET",277 "rel": "self",278 "href": "/catalog/definitions/88c1652b-fafa-40d9-99b8-3abaed84a34f",279 "uri": "/catalog/definitions/88c1652b-fafa-40d9-99b8-3abaed84a34f",280 "type": "application/vnd.sas.metadata.definition.relationship"281 },282 {283 "method": "GET",284 "rel": "alternate",285 "href": "/catalog/definitions/88c1652b-fafa-40d9-99b8-3abaed84a34f",286 "uri": "/catalog/definitions/88c1652b-fafa-40d9-99b8-3abaed84a34f",287 "type": "application/vnd.sas.metadata.definition.summary"288 },289 {290 "method": "PUT",291 "rel": "update",292 "href": "/catalog/definitions/88c1652b-fafa-40d9-99b8-3abaed84a34f",293 "uri": "/catalog/definitions/88c1652b-fafa-40d9-99b8-3abaed84a34f",294 "type": "application/vnd.sas.metadata.definition.relationship",295 "responseType": "application/vnd.sas.metadata.definition.relationship"296 },297 {298 "method": "DELETE",299 "rel": "delete",300 "href": "/catalog/definitions/88c1652b-fafa-40d9-99b8-3abaed84a34f",301 "uri": "/catalog/definitions/88c1652b-fafa-40d9-99b8-3abaed84a34f"302 },303 {304 "method": "GET",305 "rel": "up",306 "href": "/catalog/definitions",307 "uri": "/catalog/definitions",308 "type": "application/vnd.sas.collection",309 "itemType": "application/vnd.sas.metadata.definition.summary"310 }311 ],312 "version": 2,313 "definitionType": "relationship",314 "name": "history",315 "label": "Entity history",316 "description": "Link to previous version.",317 "i18nSource": "catalog-gui-icu",318 "cascadeDelete": "SourceToTarget",319 "role": "Associated",320 "cardinality": "ONE_TO_ONE",321 "endpointDefinition1": {322 "name": "previous",323 "label": "Previous",324 "description": "The previous element (newer) in the history list.",325 "elementType": "base",326 "container": false327 },328 "endpointDefinition2": {329 "name": "next",330 "label": "Next",331 "description": "The next element (older) in the history list.",332 "elementType": "base",333 "container": true334 }335 },336 {337 "creationTimeStamp": "0001-01-01T00:00:00Z",338 "modifiedTimeStamp": "2023-06-29T00:00:00Z",339 "id": "44564985-935b-460f-a5e9-042fbf05926e",340 "links": [341 {342 "method": "GET",343 "rel": "self",344 "href": "/catalog/definitions/44564985-935b-460f-a5e9-042fbf05926e",345 "uri": "/catalog/definitions/44564985-935b-460f-a5e9-042fbf05926e",346 "type": "application/vnd.sas.metadata.definition.relationship"347 },348 {349 "method": "GET",350 "rel": "alternate",351 "href": "/catalog/definitions/44564985-935b-460f-a5e9-042fbf05926e",352 "uri": "/catalog/definitions/44564985-935b-460f-a5e9-042fbf05926e",353 "type": "application/vnd.sas.metadata.definition.summary"354 },355 {356 "method": "PUT",357 "rel": "update",358 "href": "/catalog/definitions/44564985-935b-460f-a5e9-042fbf05926e",359 "uri": "/catalog/definitions/44564985-935b-460f-a5e9-042fbf05926e",360 "type": "application/vnd.sas.metadata.definition.relationship",361 "responseType": "application/vnd.sas.metadata.definition.relationship"362 },363 {364 "method": "DELETE",365 "rel": "delete",366 "href": "/catalog/definitions/44564985-935b-460f-a5e9-042fbf05926e",367 "uri": "/catalog/definitions/44564985-935b-460f-a5e9-042fbf05926e"368 },369 {370 "method": "GET",371 "rel": "up",372 "href": "/catalog/definitions",373 "uri": "/catalog/definitions",374 "type": "application/vnd.sas.collection",375 "itemType": "application/vnd.sas.metadata.definition.summary"376 }377 ],378 "version": 2,379 "definitionType": "relationship",380 "name": "commentsOnSubject",381 "label": "Subject to comments",382 "description": "Subject to the comments contained.",383 "attributeDefinitions": {384 "type": {385 "name": "type",386 "label": "Type of comment",387 "description": "The category or classification of the comment being assigned to the subject.",388 "type": "commentType"389 }390 },391 "i18nSource": "catalog-gui-icu",392 "cascadeDelete": "None",393 "role": "Associated",394 "cardinality": "ONE_TO_MANY",395 "endpointDefinition1": {396 "name": "subjectOfComment",397 "label": "Subject of comment",398 "description": "Subject the comments are applied to.",399 "elementType": "base",400 "container": false401 },402 "endpointDefinition2": {403 "name": "comments",404 "label": "Comments",405 "description": "Comment to be applied to subject.",406 "elementType": "comment",407 "container": false408 }409 },410 {411 "creationTimeStamp": "0001-01-01T00:00:00Z",412 "modifiedTimeStamp": "2023-06-29T00:00:00Z",413 "id": "82809c23-924b-4809-8ef3-7eb4b355e5a4",414 "links": [415 {416 "method": "GET",417 "rel": "self",418 "href": "/catalog/definitions/82809c23-924b-4809-8ef3-7eb4b355e5a4",419 "uri": "/catalog/definitions/82809c23-924b-4809-8ef3-7eb4b355e5a4",420 "type": "application/vnd.sas.metadata.definition.relationship"421 },422 {423 "method": "GET",424 "rel": "alternate",425 "href": "/catalog/definitions/82809c23-924b-4809-8ef3-7eb4b355e5a4",426 "uri": "/catalog/definitions/82809c23-924b-4809-8ef3-7eb4b355e5a4",427 "type": "application/vnd.sas.metadata.definition.summary"428 },429 {430 "method": "PUT",431 "rel": "update",432 "href": "/catalog/definitions/82809c23-924b-4809-8ef3-7eb4b355e5a4",433 "uri": "/catalog/definitions/82809c23-924b-4809-8ef3-7eb4b355e5a4",434 "type": "application/vnd.sas.metadata.definition.relationship",435 "responseType": "application/vnd.sas.metadata.definition.relationship"436 },437 {438 "method": "DELETE",439 "rel": "delete",440 "href": "/catalog/definitions/82809c23-924b-4809-8ef3-7eb4b355e5a4",441 "uri": "/catalog/definitions/82809c23-924b-4809-8ef3-7eb4b355e5a4"442 },443 {444 "method": "GET",445 "rel": "up",446 "href": "/catalog/definitions",447 "uri": "/catalog/definitions",448 "type": "application/vnd.sas.collection",449 "itemType": "application/vnd.sas.metadata.definition.summary"450 }451 ],452 "version": 2,453 "definitionType": "relationship",454 "name": "responsibleParties",455 "label": "Base to identities",456 "description": "Base to the identities related.",457 "i18nSource": "catalog-gui-icu",458 "cascadeDelete": "None",459 "role": "Associated",460 "cardinality": "ONE_TO_MANY",461 "endpointDefinition1": {462 "name": "subjectForResponsibility",463 "label": "Subject for responsibility",464 "description": "Subject the identities are applied to.",465 "elementType": "base",466 "container": false467 },468 "endpointDefinition2": {469 "name": "responsibleParties",470 "label": "Responsible Parties",471 "description": "Identity to be applied to subject.",472 "elementType": "identity",473 "container": false474 }475 },476 {477 "creationTimeStamp": "0001-01-01T00:00:00Z",478 "modifiedTimeStamp": "2023-06-29T00:00:00Z",479 "id": "3ee3ab0d-d927-4963-b9cf-162118a4b3c1",480 "links": [481 {482 "method": "GET",483 "rel": "self",484 "href": "/catalog/definitions/3ee3ab0d-d927-4963-b9cf-162118a4b3c1",485 "uri": "/catalog/definitions/3ee3ab0d-d927-4963-b9cf-162118a4b3c1",486 "type": "application/vnd.sas.metadata.definition.relationship"487 },488 {489 "method": "GET",490 "rel": "alternate",491 "href": "/catalog/definitions/3ee3ab0d-d927-4963-b9cf-162118a4b3c1",492 "uri": "/catalog/definitions/3ee3ab0d-d927-4963-b9cf-162118a4b3c1",493 "type": "application/vnd.sas.metadata.definition.summary"494 },495 {496 "method": "PUT",497 "rel": "update",498 "href": "/catalog/definitions/3ee3ab0d-d927-4963-b9cf-162118a4b3c1",499 "uri": "/catalog/definitions/3ee3ab0d-d927-4963-b9cf-162118a4b3c1",500 "type": "application/vnd.sas.metadata.definition.relationship",501 "responseType": "application/vnd.sas.metadata.definition.relationship"502 },503 {504 "method": "DELETE",505 "rel": "delete",506 "href": "/catalog/definitions/3ee3ab0d-d927-4963-b9cf-162118a4b3c1",507 "uri": "/catalog/definitions/3ee3ab0d-d927-4963-b9cf-162118a4b3c1"508 },509 {510 "method": "GET",511 "rel": "up",512 "href": "/catalog/definitions",513 "uri": "/catalog/definitions",514 "type": "application/vnd.sas.collection",515 "itemType": "application/vnd.sas.metadata.definition.summary"516 }517 ],518 "version": 2,519 "definitionType": "relationship",520 "name": "annotatedObjects",521 "label": "Base to Tags",522 "description": "Base to tags applied to entity.",523 "i18nSource": "catalog-gui-icu",524 "cascadeDelete": "None",525 "role": "Associated",526 "cardinality": "MANY_TO_MANY",527 "endpointDefinition1": {528 "name": "subjects",529 "label": "Subjects",530 "description": "Subjects related to this tag.",531 "elementType": "base",532 "container": false533 },534 "endpointDefinition2": {535 "name": "tags",536 "label": "Tags",537 "description": "Tags applied to this object.",538 "elementType": "annotation",539 "container": false540 }541 }542 ],543 "version": 2544}
Name | Type | Required | Description |
---|---|---|---|
Accept | string | false | The desired item representation for the response. The default is application/vnd.sas.metadata.definition.archive+json. Allowed value: application/vnd.sas.metadata.definition.archive+json Default: application/vnd.sas.metadata.definition.archive+json |
Status | Meaning | Description | ||
---|---|---|---|---|
200 | OK | The request succeeded. | Headers | Schema |
400 | Bad Request | Bad request (the request is not well-formed). | Schema | |
401 | Unauthorized | Not authenticated. | Schema | |
403 | Forbidden | The user does not have permission to complete this request. | Schema | |
409 | Conflict | A conflict has occurred. | Schema |