-
Notifications
You must be signed in to change notification settings - Fork 7
/
orderOption.graphql
159 lines (116 loc) · 5.35 KB
/
orderOption.graphql
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
type OrderOption {
"The list of concepts and any data on the relationship between this order option and other permitted concepts"
associationDetails: JSON
"The concept ID created by CMR for this order option"
conceptId: String!
"Indicates if the definition is deprecated. Deprecated definitions will be returned to the client and will be considered valid when validating an order, however new order items cannot be added using the definition and existing order items cannot be updated using the definition. This flag is ignored when creating an option definition, however it will always be set and returned once the definition has been created."
deprecated: Boolean
"The description is a longer, human-readable description of the order option type or contents, intended for client display."
description: String
"Contents must conform to ECHO Forms schema. See the ECHO Forms Specification for more information."
form: String
"The name is a shortened name used to distinguish between other option definitions."
name: String
"The native ID to set on the order option."
nativeId: String
"The provider ID to set on the order option."
providerId: String
"The revision date for the order option."
revisionDate: String
"The revision id for the order option."
revisionId: String
"There are two levels of order options, provider and system. Only administrators may add system level options and only providers may add provider level options."
scope: OrderOptionScopeType
"The sort key is used to indicate the preferred display order among other definitions."
sortKey: String
collections (
"Collections query parameters"
params: CollectionsInput
): CollectionList
}
type OrderOptionList {
"The number of hits for a given search."
count: Int
"Cursor that points to the/a specific position in a list of requested records."
cursor: String
"The list of orderOption search results."
items: [OrderOption]
}
input OrderOptionsInput {
"The unique concept ID assigned to the order-option."
conceptId: [String]
"Cursor that points to the/a specific position in a list of requested records."
cursor: String
"The number of variables requested by the user."
limit: Int
"Zero based offset of individual results."
offset: Int
"The provider ID."
providerId: [String]
}
input OrderOptionInput {
"The unique concept ID assigned to the order-option."
conceptId: String
}
type Query {
orderOption(
"The order option query parameters."
params: OrderOptionInput
): OrderOption
orderOptions(
"The order option query parameters."
params: OrderOptionsInput
): OrderOptionList!
}
type OrderOptionMutationResponse {
"The concept ID of the draft."
conceptId: String!
"The revision ID of the draft."
revisionId: String!
}
enum OrderOptionScopeType {
PROVIDER
SYSTEM
}
type Mutation {
createOrderOption(
"The description is a longer, human-readable description of the order option type or contents, intended for client display."
description: String
"Contents must conform to ECHO Forms schema. See the ECHO Forms Specification for more information."
form: String
"The native ID for the order option."
nativeId: String
"The name is a shortened name used to distinguish between other option definitions. This field must be unique per provider and is restricted to 30 characters."
name: String
"The provider ID for the order option."
providerId: String!
"There are two levels of order options, provider and system. Only administrators may add system level options and only providers may add provider level options."
scope: OrderOptionScopeType
"The sort key is used to indicate the preferred display order among other definitions"
sortKey: String
): OrderOptionMutationResponse
updateOrderOption(
"Indicates if the definition is deprecated. Deprecated definitions will be returned to the client and will be considered valid when validating an order, however new order items cannot be added using the definition and existing order items cannot be updated using the definition. This flag is ignored when creating an option definition, however it will always be set and returned once the definition has been created."
deprecated: Boolean
"The description is a longer, human-readable description of the order option type or contents, intended for client display."
description: String
"Contents must conform to ECHO Forms schema. See the ECHO Forms Specification for more information."
form: String
"The name is a shortened name used to distinguish between other option definitions. This field must be unique per provider and is restricted to 30 characters."
name: String
"The native ID for the order option."
nativeId: String!
"The provider ID for the order option."
providerId: String!
"There are two levels of order options, provider and system. Only administrators may add system level options and only providers may add provider level options."
scope: OrderOptionScopeType
"The sort key is used to indicate the preferred display order among other definitions"
sortKey: String
): OrderOptionMutationResponse
deleteOrderOption(
"The native ID of the order option to be deleted."
nativeId: String!
"The provider ID of the order option to be deleted."
providerId: String!
): OrderOptionMutationResponse
}