1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326
|
.. -*- rst -*-
Metadata definition schemas
***************************
Gets a JSON-schema document that represents a metadata definition
entity.
*(Since API v2.2)*
Show metadata definition namespace schema
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/schemas/metadefs/namespace
Shows a JSON schema document that represents a metadata definition *namespace* entity.
The following schema document is an example. The authoritative response is the
actual response to the API call.
Normal response codes: 200
Error response codes: 400, 401
Request
-------
There are no request parameters. The call does not take a request body.
Response Example
----------------
.. literalinclude:: samples/schemas-metadef-namespace-show-response.json
:language: json
Show metadata definition namespaces schema
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/schemas/metadefs/namespaces
Shows a JSON schema document that represents a metadata definition *namespaces*
entity.
A namespaces entity is a container for *namespace* entities.
The following schema document is an example. The authoritative response is the
actual response to the API call.
Normal response codes: 200
Error response codes: 400, 401
Request
-------
There are no request parameters. The call does not take a request body.
Response Example
----------------
.. literalinclude:: samples/schemas-metadef-namespaces-list-response.json
:language: json
.. _md-schema-rt-assoc:
Show metadata definition namespace resource type association schema
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/schemas/metadefs/resource_type
Shows a JSON schema document that represents a metadata definition namespace
*resource type association* entity.
The following schema document is an example. The authoritative response is the
actual response to the API call.
Normal response codes: 200
Error response codes: 400, 401
Request
-------
There are no request parameters. The call does not take a request body.
Response Example
----------------
.. literalinclude:: samples/schemas-metadef-resource-type-association-show-response.json
:language: json
Show metadata definition namespace resource type associations schema
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/schemas/metadefs/resource_types
Shows a JSON schema document that represents a metadata definition namespace
*resource type associations* entity.
A resource type associations entity is a container for *resource type
association* entities.
The following schema document is an example. The authoritative response is the
actual response to the API call.
Normal response codes: 200
Error response codes: 400, 401
Request
-------
There are no request parameters. The call does not take a request body.
Response Example
----------------
.. literalinclude:: samples/schemas-metadef-resource-type-associations-list-response.json
:language: json
Show metadata definition object schema
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/schemas/metadefs/object
Shows a JSON schema document that represents a metadata definition *object*
entity.
The following schema document is an example. The authoritative response is the
actual response to the API call.
Normal response codes: 200
Error response codes: 400, 401
Request
-------
There are no request parameters. The call does not take a request body.
Response Example
----------------
.. literalinclude:: samples/schemas-metadef-object-show-response.json
:language: json
Show metadata definition objects schema
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/schemas/metadefs/objects
Shows a JSON schema document that represents a metadata definition *objects*
entity.
An objects entity is a container for *object* entities.
The following schema document is an example. The authoritative response is the
actual response to the API call.
Normal response codes: 200
Error response codes: 400, 401
Request
-------
There are no request parameters. The call does not take a request body.
Response Example
----------------
.. literalinclude:: samples/schemas-metadef-objects-list-response.json
:language: json
.. _md-schema-property:
Show metadata definition property schema
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/schemas/metadefs/property
Shows a JSON schema document that represents a metadata definition *property*
entity.
The following schema document is an example. The authoritative response is the
actual response to the API call.
Normal response codes: 200
Error response codes: 400, 401
Request
-------
There are no request parameters. The call does not take a request body.
Response Example
----------------
.. literalinclude:: samples/schemas-metadef-property-show-response.json
:language: json
Show metadata definition properties schema
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/schemas/metadefs/properties
Shows a JSON schema document that represents a metadata definition *properties* entity.
A properties entity is a container for *property* entities.
The following schema document is an example. The authoritative
response is the actual response to the API call.
Normal response codes: 200
Error response codes: 400, 401
Request
-------
There are no request parameters. The call does not take a request body.
Response Example
----------------
.. literalinclude:: samples/schemas-metadef-properties-list-response.json
:language: json
.. _md-schema-tag:
Show metadata definition tag schema
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/schemas/metadefs/tag
Shows a JSON schema document that represents a metadata definition *tag* entity.
The following schema document is an example. The authoritative response is the
actual response to the API call.
Normal response codes: 200
Error response codes: 400, 401
Request
-------
There are no request parameters. The call does not take a request body.
Response Example
----------------
.. literalinclude:: samples/schemas-metadef-tag-show-response.json
:language: json
Show metadata definition tags schema
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
.. rest_method:: GET /v2/schemas/metadefs/tags
Shows a JSON schema document that represents a metadata definition *tags*
entity.
A tags entity is a container for *tag* entities.
The following schema document is an example. The authoritative response is the
actual response to the API call.
Normal response codes: 200
Error response codes: 400, 401
Request
-------
There are no request parameters. The call does not take a request body.
Response Example
----------------
.. literalinclude:: samples/schemas-metadef-tags-list-response.json
:language: json
|