Fetch a single relationship type or an array of relationship types
get/admin/relationships
Depending on the query parameter used, returns either a single relationship by qualified name or all relationships of a given type. Using both query parameters in a single request is not supported. Use the "qualifiedName" parameter when the looking up an individual relationship by its qualified name. The qualified name can be determined from the "qualifiedName" property in the relationship type or by constructing one. Use the "type" parameter when looking up all relationships of a given type.
1{2 "id": 101321,3 "createdBy": "sasboot",4 "createdAt": "2023-06-23T20:47:08.039Z",5 "lastUpdatedBy": "sasboot",6 "lastUpdatedAt": "2023-06-23T20:47:30.024Z",7 "label": "Reported by",8 "localizedLabels": [9 {10 "id": 103196,11 "createdBy": "sasboot",12 "createdAt": "2023-06-23T20:47:08.042Z",13 "lastUpdatedBy": "sasboot",14 "lastUpdatedAt": "2023-06-23T20:47:08.042Z",15 "label": "Reported by",16 "version": 0,17 "localeCd": "en-US"18 }19 ],20 "name": "reported_by",21 "dataStoreName": "DEFAULT_STORE",22 "dataStoreDefaultSchemaName": "fdhdata",23 "tableName": "reported_by",24 "systemReserved": false,25 "historyEnabled": false,26 "version": 1,27 "lastUpdatedAtTimeFieldName": "last_updated_at_dttm",28 "createdAtTimeFieldName": "created_at_dttm",29 "dataStoreAssignedTimeZone": "Etc/UTC",30 "solutionName": "sas_visual_investigator_default",31 "solutionLabel": "SAS Visual Investigator",32 "historyTableName": "reported_by",33 "lastUpdatedByUserIdFieldName": "last_updated_by_user_id",34 "versionNumberFieldName": "version",35 "createFlagHistoryColumnName": "created_flg",36 "deleteFlagHistoryColumnName": "archived_flg",37 "updateFlagHistoryColumnName": "updated_flg",38 "reverseName": "reported",39 "reverseLabel": "Reported",40 "fromObjectName": "intel_report",41 "fromObjectLabel": "Intelligence Report",42 "toObjectName": "person",43 "toObjectLabel": "Person",44 "required": false,45 "cascadeType": "NONE",46 "cardinality": "MANY_TO_MANY",47 "type": "LINK",48 "symmetric": false,49 "managed": true,50 "joinConditions": [51 {52 "type": "Conditional",53 "leftOperand": {54 "type": "FieldRef",55 "objectName": "intel_report",56 "fieldName": "id"57 },58 "rightOperands": [59 {60 "type": "FieldRef",61 "objectName": "^RELATION^",62 "fieldName": "intelReportId"63 }64 ],65 "operator": "EQ"66 },67 {68 "type": "Conditional",69 "leftOperand": {70 "type": "FieldRef",71 "objectName": "^RELATION^",72 "fieldName": "personId"73 },74 "rightOperands": [75 {76 "type": "FieldRef",77 "objectName": "person",78 "fieldName": "id"79 }80 ],81 "operator": "EQ"82 }83 ],84 "fields": [85 {86 "id": 101545,87 "createdBy": "sasboot",88 "createdAt": "2023-06-23T20:47:08.042Z",89 "lastUpdatedBy": "sasboot",90 "lastUpdatedAt": "2023-06-23T20:47:30.024Z",91 "label": "Auto Generated Sk",92 "localizedLabels": [93 {94 "id": 103197,95 "createdBy": "sasboot",96 "createdAt": "2023-06-23T20:47:08.043Z",97 "lastUpdatedBy": "sasboot",98 "lastUpdatedAt": "2023-06-23T20:47:08.043Z",99 "label": "Auto Generated Sk",100 "version": 0,101 "localeCd": "en-US"102 }103 ],104 "name": "auto_generated_sk",105 "columnName": "auto_generated_sk",106 "dataType": "STRING",107 "length": 36,108 "required": true,109 "primaryKeyField": true,110 "unique": false,111 "autoGenerated": true,112 "systemReserved": true,113 "displayIndex": 0,114 "version": 1,115 "primaryKeySeqNo": 1,116 "readOnly": true,117 "writeOnlyAtCreate": false,118 "indexedForSearch": false,119 "showTimeZone": false,120 "ownerName": "intel_report.reported_by",121 "masked": false,122 "hidden": false123 },124 {125 "id": 101548,126 "createdBy": "sasboot",127 "createdAt": "2023-06-23T20:47:08.043Z",128 "lastUpdatedBy": "sasboot",129 "lastUpdatedAt": "2023-06-23T20:47:30.024Z",130 "label": "Report Id",131 "localizedLabels": [132 {133 "id": 103200,134 "createdBy": "sasboot",135 "createdAt": "2023-06-23T20:47:08.043Z",136 "lastUpdatedBy": "sasboot",137 "lastUpdatedAt": "2023-06-23T20:47:08.043Z",138 "label": "Report Id",139 "version": 0,140 "localeCd": "en-US"141 }142 ],143 "name": "intelReportId",144 "columnName": "intel_report_id",145 "dataType": "STRING",146 "length": 36,147 "required": true,148 "primaryKeyField": false,149 "unique": false,150 "autoGenerated": false,151 "systemReserved": true,152 "displayIndex": 1,153 "version": 1,154 "readOnly": false,155 "writeOnlyAtCreate": false,156 "indexedForSearch": false,157 "showTimeZone": false,158 "ownerName": "intel_report.reported_by",159 "masked": false,160 "hidden": false161 },162 {163 "id": 101551,164 "createdBy": "sasboot",165 "createdAt": "2023-06-23T20:47:08.044Z",166 "lastUpdatedBy": "sasboot",167 "lastUpdatedAt": "2023-06-23T20:47:30.025Z",168 "label": "Person Id",169 "localizedLabels": [170 {171 "id": 103203,172 "createdBy": "sasboot",173 "createdAt": "2023-06-23T20:47:08.044Z",174 "lastUpdatedBy": "sasboot",175 "lastUpdatedAt": "2023-06-23T20:47:08.044Z",176 "label": "Person Id",177 "version": 0,178 "localeCd": "en-US"179 }180 ],181 "name": "personId",182 "columnName": "person_id",183 "dataType": "STRING",184 "length": 36,185 "required": true,186 "primaryKeyField": false,187 "unique": false,188 "autoGenerated": false,189 "systemReserved": true,190 "displayIndex": 1,191 "version": 1,192 "readOnly": false,193 "writeOnlyAtCreate": false,194 "indexedForSearch": false,195 "showTimeZone": false,196 "ownerName": "intel_report.reported_by",197 "masked": false,198 "hidden": false199 },200 {201 "id": 101552,202 "createdBy": "sasboot",203 "createdAt": "2023-06-23T20:47:08.044Z",204 "lastUpdatedBy": "sasboot",205 "lastUpdatedAt": "2023-06-23T20:47:30.025Z",206 "label": "Version",207 "localizedLabels": [208 {209 "id": 103204,210 "createdBy": "sasboot",211 "createdAt": "2023-06-23T20:47:08.044Z",212 "lastUpdatedBy": "sasboot",213 "lastUpdatedAt": "2023-06-23T20:47:08.044Z",214 "label": "Version",215 "version": 0,216 "localeCd": "en-US"217 }218 ],219 "name": "version",220 "columnName": "version",221 "dataType": "LONG",222 "required": true,223 "primaryKeyField": false,224 "unique": false,225 "autoGenerated": false,226 "systemReserved": true,227 "displayIndex": 4,228 "version": 1,229 "readOnly": true,230 "writeOnlyAtCreate": false,231 "indexedForSearch": false,232 "showTimeZone": false,233 "ownerName": "intel_report.reported_by",234 "masked": false,235 "hidden": false236 },237 {238 "id": 101547,239 "createdBy": "sasboot",240 "createdAt": "2023-06-23T20:47:08.043Z",241 "lastUpdatedBy": "sasboot",242 "lastUpdatedAt": "2023-06-23T20:47:30.025Z",243 "label": "Created By User Id",244 "localizedLabels": [245 {246 "id": 103199,247 "createdBy": "sasboot",248 "createdAt": "2023-06-23T20:47:08.043Z",249 "lastUpdatedBy": "sasboot",250 "lastUpdatedAt": "2023-06-23T20:47:08.043Z",251 "label": "Created By User Id",252 "version": 0,253 "localeCd": "en-US"254 }255 ],256 "name": "created_by_user_id",257 "columnName": "created_by_user_id",258 "dataType": "STRING",259 "length": 255,260 "required": false,261 "primaryKeyField": false,262 "unique": false,263 "autoGenerated": false,264 "systemReserved": true,265 "displayIndex": 5,266 "version": 1,267 "readOnly": true,268 "writeOnlyAtCreate": false,269 "indexedForSearch": false,270 "showTimeZone": false,271 "ownerName": "intel_report.reported_by",272 "masked": false,273 "hidden": false274 },275 {276 "id": 101546,277 "createdBy": "sasboot",278 "createdAt": "2023-06-23T20:47:08.043Z",279 "lastUpdatedBy": "sasboot",280 "lastUpdatedAt": "2023-06-23T20:47:30.025Z",281 "label": "Created at Date/Time",282 "localizedLabels": [283 {284 "id": 103198,285 "createdBy": "sasboot",286 "createdAt": "2023-06-23T20:47:08.043Z",287 "lastUpdatedBy": "sasboot",288 "lastUpdatedAt": "2023-06-23T20:47:08.043Z",289 "label": "Created at Date/Time",290 "version": 0,291 "localeCd": "en-US"292 }293 ],294 "name": "created_at_dttm",295 "columnName": "created_at_dttm",296 "dataType": "TIMESTAMP",297 "required": false,298 "primaryKeyField": false,299 "unique": false,300 "autoGenerated": false,301 "systemReserved": true,302 "displayIndex": 6,303 "version": 1,304 "readOnly": true,305 "writeOnlyAtCreate": false,306 "indexedForSearch": false,307 "showTimeZone": false,308 "ownerName": "intel_report.reported_by",309 "masked": false,310 "hidden": false311 },312 {313 "id": 101550,314 "createdBy": "sasboot",315 "createdAt": "2023-06-23T20:47:08.044Z",316 "lastUpdatedBy": "sasboot",317 "lastUpdatedAt": "2023-06-23T20:47:30.025Z",318 "label": "Last Updated By User Id",319 "localizedLabels": [320 {321 "id": 103202,322 "createdBy": "sasboot",323 "createdAt": "2023-06-23T20:47:08.044Z",324 "lastUpdatedBy": "sasboot",325 "lastUpdatedAt": "2023-06-23T20:47:08.044Z",326 "label": "Last Updated By User Id",327 "version": 0,328 "localeCd": "en-US"329 }330 ],331 "name": "last_updated_by_user_id",332 "columnName": "last_updated_by_user_id",333 "dataType": "STRING",334 "length": 255,335 "required": false,336 "primaryKeyField": false,337 "unique": false,338 "autoGenerated": false,339 "systemReserved": true,340 "displayIndex": 7,341 "version": 1,342 "readOnly": true,343 "writeOnlyAtCreate": false,344 "indexedForSearch": false,345 "showTimeZone": false,346 "ownerName": "intel_report.reported_by",347 "masked": false,348 "hidden": false349 },350 {351 "id": 101549,352 "createdBy": "sasboot",353 "createdAt": "2023-06-23T20:47:08.044Z",354 "lastUpdatedBy": "sasboot",355 "lastUpdatedAt": "2023-06-23T20:47:30.025Z",356 "label": "Last Updated at Date/Time",357 "localizedLabels": [358 {359 "id": 103201,360 "createdBy": "sasboot",361 "createdAt": "2023-06-23T20:47:08.044Z",362 "lastUpdatedBy": "sasboot",363 "lastUpdatedAt": "2023-06-23T20:47:08.044Z",364 "label": "Last Updated at Date/Time",365 "version": 0,366 "localeCd": "en-US"367 }368 ],369 "name": "last_updated_at_dttm",370 "columnName": "last_updated_at_dttm",371 "dataType": "TIMESTAMP",372 "required": false,373 "primaryKeyField": false,374 "unique": false,375 "autoGenerated": false,376 "systemReserved": true,377 "displayIndex": 8,378 "version": 1,379 "readOnly": true,380 "writeOnlyAtCreate": false,381 "indexedForSearch": false,382 "showTimeZone": false,383 "ownerName": "intel_report.reported_by",384 "masked": false,385 "hidden": false386 }387 ],388 "localizedReverseLabels": [389 {390 "id": 103205,391 "createdBy": "sasboot",392 "createdAt": "2023-06-23T20:47:08.044Z",393 "lastUpdatedBy": "sasboot",394 "lastUpdatedAt": "2023-06-23T20:47:08.044Z",395 "label": "Reported",396 "version": 0,397 "localeCd": "en-US"398 }399 ],400 "useCustomIndex": false,401 "color": "#c3c3c3",402 "width": 1,403 "dashType": "solid",404 "reindexRequired": false,405 "readOnly": false,406 "qualifiedName": "intel_report__reported_by"407}
| Name | Type | Required | Description |
|---|---|---|---|
qualifiedName | string | false | The qualified name that uniquely identifies the relationship type. The components of a qualified name are: {"from" Entity Type name} + "__" + {Relationship Type name} |
type | string | false | Specifies the type of the relationships for which to search. LINK relationships are all relationships that link one Entity Type to one or many other Entity Types. DIRECT_CHILD relationships are a relationship between a parent Entity Type and a child Entity Type. Allowed values: DIRECT_CHILDLINK |