-
Notifications
You must be signed in to change notification settings - Fork 3
/
Copy pathpega-api-v1.raml
253 lines (252 loc) · 7.65 KB
/
pega-api-v1.raml
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
#%RAML 0.8
title: Pega API
version: v1
documentation:
- title: Pega API
content: The Pega API provides a set of built-in REST services for Pega 7 applications. All APIs require authentication. Provide the credentials for a Pega operator in the Authorization header for each request. Pega recommends accessing APIs using TLS 1.2.
baseUri: https://myorg.com/prweb/api/v1
schemas:
- AssignmentResponse: !include schemas/AssignmentResponse.json
- AssignmentActionRequest: !include schemas/AssignmentActionRequest.json
- AssignmentsResponse: !include schemas/AssignmentsResponse.json
- CaseResponse: !include schemas/CaseResponse.json
- UpdateCaseRequest: !include schemas/UpdateCaseRequest.json
- CasesResponse: !include schemas/CasesResponse.json
- CreateCaseRequest: !include schemas/CreateCaseRequest.json
- CreateCaseResponse: !include schemas/CreateCaseResponse.json
- CaseTypesResponse: !include schemas/CaseTypesResponse.json
- DataPageMetadata: !include schemas/DataPageMetadata.json
- UserSessionTerminationRequest: !include schemas/UserSessionTerminationRequest.json
- UserSessionTerminationResponse: !include schemas/UserSessionTerminationResponse.json
/assignments:
/{ID}:
uriParameters:
ID:
description: Assignment ID/'next'
type: string
required: true
displayName: ID
get:
displayName: getAssignmentDetails
description: Get assignment details - Returns a single assignment's details given its ID (or) Returns the next available assignment for the requestor if 'next' is passed.
responses:
200:
description: OK
body:
application/json:
schema: AssignmentResponse
401:
description: Unauthorized
403:
description: Forbidden
404:
description: No assignment found or available
post:
body:
application/json:
schema: AssignmentActionRequest
displayName: performAssignmentAction
description: Perform assignment action - Performs an action on an assignment given its ID and an optional content in the request body.
responses:
400:
description: Bad request
401:
description: Unauthorized
403:
description: Forbidden
404:
description: Not found
queryParameters:
actionID:
description: Assignment action to perform
type: string
required: true
displayName: actionID
get:
displayName: getAssignments
description: Get assignments - Returns the authenticated user's list of assignments.
responses:
200:
description: OK
body:
application/json:
schema: AssignmentsResponse
401:
description: Unauthorized
403:
description: Forbidden
/authenticate:
get:
displayName: authenticate
description: Verify user credentials - Verifies if the credentials provided in Authorization header using *Basic* authentication are valid or not.
responses:
401:
description: Unauthorized
403:
description: Forbidden
/cases:
/{ID}:
uriParameters:
ID:
description: Case ID
type: string
required: true
displayName: ID
get:
displayName: getCaseDetails
description: Get case details - Gets the details of a case given its ID.
responses:
200:
description: OK
body:
application/json:
schema: CaseResponse
401:
description: Unauthorized
403:
description: Forbidden
404:
description: Not found
put:
body:
application/json:
schema: UpdateCaseRequest
displayName: updateCase
description: Update a case - Performs an action given a case ID and an optional content in the request body.
responses:
200:
description: No content
400:
description: Bad request
401:
description: Unauthorized
403:
description: Forbidden
404:
description: Not found
412:
description: Precondition failed
headers:
If-Match:
description: Value of the entity tag that is received as ETag header in responses to create case and get case details APIs
type: string
required: true
displayName: If-Match
queryParameters:
actionID:
description: Local action or a stage local action to perform
type: string
required: false
displayName: actionID
get:
displayName: getCases
description: Get cases - Gets all cases that the authenticated user has created in the default work pool.
responses:
200:
description: OK
body:
application/json:
schema: CasesResponse
401:
description: Unauthorized
403:
description: Forbidden
post:
body:
application/json:
schema: CreateCaseRequest
displayName: createCase
description: Create a new case - Creates a new case of the given type.
responses:
200:
description: Created
body:
application/json:
schema: CreateCaseResponse
400:
description: Bad request
401:
description: Unauthorized
403:
description: Forbidden
/casetypes:
get:
displayName: getCaseTypes
description: Get case types - Gets the case types from the authenticated user's application.
responses:
200:
description: OK
body:
application/json:
schema: CaseTypesResponse
401:
description: Unauthorized
403:
description: Forbidden
/data/{ID}:
uriParameters:
ID:
description: Data page identifier
type: string
required: true
displayName: ID
/metadata:
uriParameters:
ID:
description: Data page identifier
type: string
required: true
displayName: ID
get:
displayName: getDataPageMetadata
description: Get data page metadata - Gets the metadata of a data page given its name.
responses:
200:
description: OK
body:
application/json:
schema: DataPageMetadata
401:
description: Unauthorized
403:
description: Forbidden
404:
description: Not found
get:
displayName: getDataPage
description: Get data page contents - Gets the contents of a data page given its name and parameters.
responses:
401:
description: Unauthorized
403:
description: Forbidden
404:
description: Not found
/docs:
get:
displayName: Docs
description: Get the complete documentation for Pega API.
responses:
401:
description: Unauthorized
403:
description: Forbidden
/users/logout:
post:
body:
application/json:
schema: UserSessionTerminationRequest
displayName: logout
description: Terminates all existing sessions in all nodes of the cluster for the given set of users.
responses:
200:
description: Request Received Succesfully
body:
application/json:
schema: UserSessionTerminationResponse
400:
description: Bad request
401:
description: Unauthorized
403:
description: Forbidden