You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: versions/3.0.0.md
+27-13Lines changed: 27 additions & 13 deletions
Original file line number
Diff line number
Diff line change
@@ -1780,9 +1780,9 @@ This object MAY be extended with [Specification Extensions](#specificationExtens
1780
1780
Field Name | Type | Description
1781
1781
---|:---:|---
1782
1782
<a name="responseContent"></a>content | Map[`string`, [Media Type Object](#mediaTypeObject)] | **SHOULD** Use media type definitions listed at <a href="https://www.iana.org/assignments/media-types/media-types.xhtml">RFC6838</a>.
1783
-
<a name="responseProfile"></a>x-responseSchema| `URI` | Conformance to a particular schema/format.
1784
-
<a name="responseDataType"></a>x-responseValueType | [`responseValueType object`] | To specify the types of objects in the response. The responseValueType object consists of a required `x-valueType` that should provide URI values to the type of object, and an optional `x-path` to specify to ___location in the response for that valueType.
<a name="responseSchema"></a>| `URI` | Specify the json schema using a Reference Object, or use "x-uri" as an additional property in the schema field to point to an external ___location for an XML, RDF, etc schema.
1784
+
<a name="responseDataType"></a>x-responseValueType | [`responseValueType`] \| [Reference Object](#referenceObject)] | Specify the types of objects and relations in the response using either a reference to the JSON-LD context file or to a [Response Value Type](responseValueType).
1785
+
1786
1786
1787
1787
##### Response Object Examples
1788
1788
@@ -1906,19 +1906,33 @@ Response with no return value:
1906
1906
```yaml
1907
1907
description: object created
1908
1908
```
1909
-
##### Response Object smartAPI Examples
1909
+
1910
+
1911
+
1912
+
1913
+
1914
+
#### <a name="responseValueType"></a>Response Value Type [smartAPI extension]
1915
+
1916
+
that should provide URI values to the type of object, and an optional `x-path` to specify to ___location in the response for that valueType.
1917
+
1918
+
1919
+
##### smartAPI Fields
1920
+
1921
+
Field Name | Type | Description
1922
+
---|:---:|---
1923
+
<a name="responseValueTypeObjectPath"></a>x-path | `string` | The path using dot notation to the element of interest. e.g. friend.name to follow the path from root object to the name attribute to the name field
1924
+
<a name="responseValueTypeObjectValue"></a>x-valueType | `string` | The value type for the field. e.g.
0 commit comments