1 | # Response Schema
|
2 |
|
3 | ```txt
|
4 | https://ns.adobe.com/helix/pipeline/response
|
5 | ```
|
6 |
|
7 | The HTTP response object
|
8 |
|
9 |
|
10 | | Abstract | Extensible | Status | Identifiable | Custom Properties | Additional Properties | Access Restrictions | Defined In |
|
11 | | :------------------ | ---------- | ----------- | ------------ | :---------------- | --------------------- | ------------------- | ------------------------------------------------------------------- |
|
12 | | Can be instantiated | No | Stabilizing | No | Forbidden | Forbidden | none | [response.schema.json](response.schema.json "open original schema") |
|
13 |
|
14 | ## Response Type
|
15 |
|
16 | `object` ([Response](response.md))
|
17 |
|
18 | # Response Properties
|
19 |
|
20 | | Property | Type | Required | Nullable | Defined by |
|
21 | | :-------------------- | ------------- | -------- | -------------- | :------------------------------------------------------------------------------------------------------------------- |
|
22 | | [status](#status) | `integer` | Optional | cannot be null | [Response](response-properties-status.md "https://ns.adobe.com/helix/pipeline/response#/properties/status") |
|
23 | | [body](#body) | Merged | Optional | cannot be null | [Response](response-properties-body.md "https://ns.adobe.com/helix/pipeline/response#/properties/body") |
|
24 | | [document](#document) | `object` | Optional | cannot be null | [Response](response-properties-document.md "https://ns.adobe.com/helix/pipeline/response#/properties/document") |
|
25 | | [headers](#headers) | Not specified | Optional | cannot be null | [Response](response-properties-headers.md "https://ns.adobe.com/helix/pipeline/response#/properties/headers") |
|
26 |
|
27 | ## status
|
28 |
|
29 | The HTTP status code
|
30 |
|
31 |
|
32 | `status`
|
33 |
|
34 | - is optional
|
35 | - Type: `integer`
|
36 | - cannot be null
|
37 | - defined in: [Response](response-properties-status.md "https://ns.adobe.com/helix/pipeline/response#/properties/status")
|
38 |
|
39 | ### status Type
|
40 |
|
41 | `integer`
|
42 |
|
43 | ## body
|
44 |
|
45 |
|
46 |
|
47 |
|
48 | `body`
|
49 |
|
50 | - is optional
|
51 | - Type: merged type ([Details](response-properties-body.md))
|
52 | - cannot be null
|
53 | - defined in: [Response](response-properties-body.md "https://ns.adobe.com/helix/pipeline/response#/properties/body")
|
54 |
|
55 | ### body Type
|
56 |
|
57 | merged type ([Details](response-properties-body.md))
|
58 |
|
59 | any of
|
60 |
|
61 | - [Untitled undefined type in Response](response-properties-body-anyof-0.md "check type definition")
|
62 | - [Untitled object in Response](response-properties-body-anyof-1.md "check type definition")
|
63 |
|
64 | ## document
|
65 |
|
66 | The DOM-compatible representation of the response document
|
67 |
|
68 |
|
69 | `document`
|
70 |
|
71 | - is optional
|
72 | - Type: `object` ([Details](response-properties-document.md))
|
73 | - cannot be null
|
74 | - defined in: [Response](response-properties-document.md "https://ns.adobe.com/helix/pipeline/response#/properties/document")
|
75 |
|
76 | ### document Type
|
77 |
|
78 | `object` ([Details](response-properties-document.md))
|
79 |
|
80 | ## headers
|
81 |
|
82 | The HTTP headers of the response
|
83 |
|
84 |
|
85 | `headers`
|
86 |
|
87 | - is optional
|
88 | - Type: unknown
|
89 | - cannot be null
|
90 | - defined in: [Response](response-properties-headers.md "https://ns.adobe.com/helix/pipeline/response#/properties/headers")
|
91 |
|
92 | ### headers Type
|
93 |
|
94 | unknown
|