Get relationships types
Returns a collection of relationships types. The media type of the returned collection items is application/vnd.sas.relationship.type+json
. Accept-Language
is specified to return locale-specific labels and descriptions.
1{2 "version": 2,3 "accept": "application/vnd.sas.relationship.type",4 "count": 7,5 "start": 0,6 "limit": 10,7 "name": "items",8 "items": [9 {10 "version": 1,11 "name": "Dependent",12 "description": "A dependency exists when an object cannot function or be defined without the related object. For example, this \"job\" object must have its source \"table\" object.",13 "label": "Is dependent on",14 "directional": true,15 "partnerLabel": "Impacts",16 "partnerDescription": "This object impacts the other object.",17 "links": [18 {19 "method": "GET",20 "rel": "self",21 "href": "/relationships/types/Dependent",22 "uri": "/relationships/types/Dependent",23 "type": "application/vnd.sas.relationship.type"24 },25 {26 "method": "GET",27 "rel": "up",28 "href": "/relationships/types",29 "uri": "/relationships/types",30 "type": "application/vnd.sas.relationship.type"31 }32 ]33 },34 {35 "version": 1,36 "name": "Contains",37 "description": "An application that models the structure of a top-level entity. A parent object contains another object when the contained object does not make sense or exist without the parent object. For example, a \"table\" object contains a \"column\" object.",38 "label": "Contains",39 "directional": true,40 "partnerLabel": "Is contained by",41 "partnerDescription": "This object is contained by another object.",42 "links": [43 {44 "method": "GET",45 "rel": "self",46 "href": "/relationships/types/Contains",47 "uri": "/relationships/types/Contains",48 "type": "application/vnd.sas.relationship.type"49 },50 {51 "method": "GET",52 "rel": "up",53 "href": "/relationships/types",54 "uri": "/relationships/types",55 "type": "application/vnd.sas.relationship.type"56 }57 ]58 },59 {60 "version": 1,61 "name": "Parent",62 "description": "This relationship describes the parent in a parent-child hierarchy.",63 "label": "Is parent of",64 "directional": true,65 "partnerLabel": "Is child of",66 "partnerDescription": "This relationship describes the child in a parent-child hierarchy.",67 "links": [68 {69 "method": "GET",70 "rel": "self",71 "href": "/relationships/types/Parent",72 "uri": "/relationships/types/Parent",73 "type": "application/vnd.sas.relationship.type"74 },75 {76 "method": "GET",77 "rel": "up",78 "href": "/relationships/types",79 "uri": "/relationships/types",80 "type": "application/vnd.sas.relationship.type"81 }82 ]83 },84 {85 "version": 1,86 "name": "Version",87 "description": "This relationship relates an object to a version of this object.",88 "label": "Has a version of",89 "directional": true,90 "partnerLabel": "Is version of",91 "partnerDescription": "This object is a version of the other.",92 "links": [93 {94 "method": "GET",95 "rel": "self",96 "href": "/relationships/types/Version",97 "uri": "/relationships/types/Version",98 "type": "application/vnd.sas.relationship.type"99 },100 {101 "method": "GET",102 "rel": "up",103 "href": "/relationships/types",104 "uri": "/relationships/types",105 "type": "application/vnd.sas.relationship.type"106 }107 ]108 },109 {110 "version": 1,111 "name": "Associated",112 "description": "This relationship describes a general association between two objects.",113 "label": "Is associated with",114 "directional": false,115 "links": [116 {117 "method": "GET",118 "rel": "self",119 "href": "/relationships/types/Associated",120 "uri": "/relationships/types/Associated",121 "type": "application/vnd.sas.relationship.type"122 },123 {124 "method": "GET",125 "rel": "up",126 "href": "/relationships/types",127 "uri": "/relationships/types",128 "type": "application/vnd.sas.relationship.type"129 }130 ]131 },132 {133 "version": 1,134 "name": "Equivalent",135 "description": "This relationship equates two objects that represent the same entity.",136 "label": "Is equivalent to",137 "directional": false,138 "links": [139 {140 "method": "GET",141 "rel": "self",142 "href": "/relationships/types/Equivalent",143 "uri": "/relationships/types/Equivalent",144 "type": "application/vnd.sas.relationship.type"145 },146 {147 "method": "GET",148 "rel": "up",149 "href": "/relationships/types",150 "uri": "/relationships/types",151 "type": "application/vnd.sas.relationship.type"152 }153 ]154 },155 {156 "version": 1,157 "name": "Synonymous",158 "description": "This relationship equates two objects that have the same connotations, implications, or reference.",159 "label": "Is synonymous with",160 "directional": false,161 "links": [162 {163 "method": "GET",164 "rel": "self",165 "href": "/relationships/types/Synonymous",166 "uri": "/relationships/types/Synonymous",167 "type": "application/vnd.sas.relationship.type"168 },169 {170 "method": "GET",171 "rel": "up",172 "href": "/relationships/types",173 "uri": "/relationships/types",174 "type": "application/vnd.sas.relationship.type"175 }176 ]177 }178 ],179 "links": [180 {181 "method": "GET",182 "rel": "self",183 "href": "/relationships/types?start=0&limit=10&sortBy=name",184 "uri": "/relationships/types?start=0&limit=10&sortBy=name",185 "type": "application/vnd.sas.collection",186 "itemType": "application/vnd.sas.relationship.type"187 },188 {189 "method": "GET",190 "rel": "collection",191 "href": "/relationships/types",192 "uri": "/relationships/types",193 "type": "application/vnd.sas.collection",194 "itemType": "application/vnd.sas.relationship.type"195 },196 {197 "method": "GET",198 "rel": "up",199 "href": "/relationships",200 "uri": "/relationships",201 "type": "application/vnd.sas.api"202 }203 ]204}
Name | Type | Required | Description |
---|---|---|---|
filter | string<filter-criteria> | false | Filter criteria for returned types. Filters are supported on the following top level fields for types: |
limit | integer | false | The maximum number of types to return in this page of results. The actual number of returned types may be less if the collection has been exhausted. Default: 50 |
sortBy | string<sort-criteria> | false | Sort returned types. The sort criteria supports the following fields in ascending or descending order: Default: name |
start | integer | false | The starting index of the first relationship type in a page. Default: 0 |
Status | Meaning | Description | ||
---|---|---|---|---|
200 | OK | Ok. | Headers | Schema |
400 | Bad Request | Bad request (the request is not well-formed). | Schema |