-
Notifications
You must be signed in to change notification settings - Fork 0
/
pingone-agreementmanagement.yml
198 lines (198 loc) · 6.77 KB
/
pingone-agreementmanagement.yml
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
openapi: 3.0.0
info:
title: PingOne Platform API - Agreement Management
description: The PingOne Platform API covering the PingOne Agreement Management service
version: '2023-06-29'
servers:
- url: '{protocol}://{baseDomain}.{suffix}'
description: PingOne Platform API Endpoint
variables:
suffix:
enum:
- 'eu'
- 'com'
- 'asia'
- 'ca'
default: 'com'
baseDomain:
default: 'agreement-mgmt.pingone'
protocol:
default: 'https'
- url: '{protocol}://{baseHostname}'
description: PingOne Platform API Endpoint
variables:
baseHostname:
default: 'agreement-mgmt.pingone.com'
protocol:
default: 'https'
components:
securitySchemes:
bearer:
type: http
scheme: bearer
bearerFormat: JWT
description: OAuth bearer token (see documentation)
schemas:
AgreementRevisionText:
type: object
properties:
resourcePath:
type: string
data:
type: string
dataType:
type: string
P1Error:
type: object
properties:
id:
description: A unique identifier that is stored in log files and always included in an error response. This value can be used to track the error received by the client, with server-side activity included for troubleshooting purposes.
type: string
code:
description: A general fault code which the client must handle to provide all exception handling routines and to localize messages for users. This code is common across all PingOne services and is human readable (such as a defined constant rather than a number).
type: string
message:
description: A short description of the error. This message is intended to assist with debugging and is returned in English only.
type: string
details:
description: Additional details about the error. Optional information to help resolve the error and to display to users.
type: array
items:
type: object
properties:
code:
description: A general fault code which the client must handle to provide all exception handling routines and to localize messages for users. This code is common across all PingOne services and is human readable (such as a defined constant rather than a number).
type: string
target:
description: The item that caused the error (such as a form field ID or an attribute inside a JSON object).
type: string
message:
description: A short description of the error. This message is intended to assist with debugging and is returned in English only.
type: string
innerError:
description: Additional details to help the client developer resolve the fault (primarily for UI validation reasons).
type: object
properties:
rangeMinimumValue:
description: Errors that failed due to range violation. This attribute represents the minimum value of the range.
type: integer
rangeMaximumValue:
description: The maximum range or value of an attribute.
type: integer
allowedPattern:
description: A regex pattern describing an acceptable input pattern.
type: string
allowedValues:
description: A list describing acceptable values.
type: array
items:
type: string
maximumValue:
description: The maximum value allowed for the request.
type: integer
referencedValues:
type: array
items:
type: string
responses:
'400':
description: Invalid request received. Malformed JSON, malformed HTTP request.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'401':
description: Request failed due to authorization issue.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'403':
description: Request failed due to authorization issue.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'404':
description: Not found.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'405':
description: Invalid request received. Malformed JSON, malformed HTTP request.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'409':
description: Conflict.
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'429':
description: Request was rate limited
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
'500':
description: Uncaught error occurred. Platform outage
content:
application/json:
schema:
$ref: '#/components/schemas/P1Error'
security:
- bearer: []
tags:
- name: Agreement Revisions Resources
paths:
/environments/{environmentID}/agreements/{agreementID}/languages/{languageID}/revisions/{revisionID}.json:
get:
tags:
- Agreement Revisions Resources
summary: READ One Agreement Language Revision
operationId: readOneAgreementLanguageRevision
parameters:
- name: environmentID
in: path
schema:
type: string
required: true
- name: agreementID
in: path
schema:
type: string
required: true
- name: languageID
in: path
schema:
type: string
required: true
- name: revisionID
in: path
schema:
type: string
required: true
responses:
'400':
$ref: '#/components/responses/400'
'401':
$ref: '#/components/responses/401'
'403':
$ref: '#/components/responses/403'
'404':
$ref: '#/components/responses/404'
'409':
$ref: '#/components/responses/409'
'429':
$ref: '#/components/responses/429'
'500':
$ref: '#/components/responses/500'
'200':
description: Successful response
content:
application/json:
schema:
$ref: '#/components/schemas/AgreementRevisionText'