@digdir/dialogporten-schema 1.72.1-fea0aee → 1.73.0-7eb16bf
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/package.json +1 -1
- package/schema.verified.graphql +119 -1
- package/src/index.js +118 -0
- package/swagger.verified.json +45 -7
package/package.json
CHANGED
package/schema.verified.graphql
CHANGED
|
@@ -37,36 +37,58 @@ type Actor {
|
|
|
37
37
|
}
|
|
38
38
|
|
|
39
39
|
type ApiAction {
|
|
40
|
+
"The unique identifier for the action in UUIDv7 format."
|
|
40
41
|
id: UUID!
|
|
42
|
+
"String identifier for the action, corresponding to the 'action' attributeId used in the XACML service policy, which by default is the policy belonging to the service referred to by 'serviceResource' in the dialog."
|
|
41
43
|
action: String!
|
|
44
|
+
"Contains an authorization resource attributeId, that can used in custom authorization rules in the XACML service policy, which by default is the policy belonging to the service referred to by 'serviceResource' in the dialog. Can also be used to refer to other service policies."
|
|
42
45
|
authorizationAttribute: String
|
|
46
|
+
"True if the authenticated user is authorized for this action. If not, the action will not be available and all endpoints will be replaced with a fixed placeholder."
|
|
43
47
|
isAuthorized: Boolean!
|
|
48
|
+
"The logical name of the operation the API action refers to."
|
|
44
49
|
name: String
|
|
50
|
+
"The endpoints associated with the action."
|
|
45
51
|
endpoints: [ApiActionEndpoint!]!
|
|
46
52
|
}
|
|
47
53
|
|
|
48
54
|
type ApiActionEndpoint {
|
|
55
|
+
"The unique identifier for the endpoint in UUIDv7 format."
|
|
49
56
|
id: UUID!
|
|
57
|
+
"Arbitrary string indicating the version of the endpoint. Consult the service-specific documentation provided by the service owner for details (if in use)."
|
|
50
58
|
version: String
|
|
59
|
+
"The fully qualified URL of the API endpoint. Will be set to 'urn:dialogporten:unauthorized' if the user is not authorized to perform the action."
|
|
51
60
|
url: URL!
|
|
61
|
+
"The HTTP method that the endpoint expects for this action."
|
|
52
62
|
httpMethod: HttpVerb!
|
|
63
|
+
"Link to service provider documentation for the endpoint. Used for service owners to provide documentation for integrators. Should be a URL to a human-readable page."
|
|
53
64
|
documentationUrl: URL
|
|
65
|
+
"Link to the request schema for the endpoint. Used by service owners to provide documentation for integrators. Dialogporten will not validate information on this endpoint."
|
|
54
66
|
requestSchema: URL
|
|
67
|
+
"Link to the response schema for the endpoint. Used for service owners to provide documentation for integrators. Dialogporten will not validate information on this endpoint."
|
|
55
68
|
responseSchema: URL
|
|
69
|
+
"Boolean indicating if the endpoint is deprecated. Integrators should migrate to endpoints with a higher version."
|
|
56
70
|
deprecated: Boolean!
|
|
71
|
+
"Date and time when the service owner has indicated that endpoint will no longer function. Only set if the endpoint is deprecated. Dialogporten will not enforce this date."
|
|
57
72
|
sunsetAt: DateTime
|
|
58
73
|
}
|
|
59
74
|
|
|
60
75
|
type Attachment {
|
|
76
|
+
"The unique identifier for the attachment in UUIDv7 format."
|
|
61
77
|
id: UUID!
|
|
78
|
+
"The display name of the attachment that should be used in GUIs."
|
|
62
79
|
displayName: [Localization!]!
|
|
80
|
+
"The URLs associated with the attachment, each referring to a different representation of the attachment."
|
|
63
81
|
urls: [AttachmentUrl!]!
|
|
64
82
|
}
|
|
65
83
|
|
|
66
84
|
type AttachmentUrl {
|
|
85
|
+
"The unique identifier for the attachment URL in UUIDv7 format."
|
|
67
86
|
id: UUID!
|
|
87
|
+
"The fully qualified URL of the attachment."
|
|
68
88
|
url: URL!
|
|
89
|
+
"The media type of the attachment."
|
|
69
90
|
mediaType: String
|
|
91
|
+
"What type of consumer the URL is intended for."
|
|
70
92
|
consumerType: AttachmentUrlConsumer!
|
|
71
93
|
}
|
|
72
94
|
|
|
@@ -118,11 +140,17 @@ type BulkSetSystemLabelValidationError implements BulkSetSystemLabelError {
|
|
|
118
140
|
}
|
|
119
141
|
|
|
120
142
|
type Content {
|
|
143
|
+
"The title of the dialog."
|
|
121
144
|
title: ContentValue!
|
|
145
|
+
"A short summary of the dialog and its current state."
|
|
122
146
|
summary: ContentValue
|
|
147
|
+
"Overridden sender name. If not supplied, assume 'org' as the sender name."
|
|
123
148
|
senderName: ContentValue
|
|
149
|
+
"Additional information about the dialog, this may contain Markdown."
|
|
124
150
|
additionalInfo: ContentValue
|
|
151
|
+
"Used as the human-readable label used to describe the 'ExtendedStatus' field."
|
|
125
152
|
extendedStatus: ContentValue
|
|
153
|
+
"Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL."
|
|
126
154
|
mainContentReference: ContentValue
|
|
127
155
|
}
|
|
128
156
|
|
|
@@ -132,36 +160,69 @@ type ContentValue {
|
|
|
132
160
|
}
|
|
133
161
|
|
|
134
162
|
type Dialog {
|
|
163
|
+
"The unique identifier for the dialog in UUIDv7 format. Example: 01913cd5-784f-7d3b-abef-4c77b1f0972d"
|
|
135
164
|
id: UUID!
|
|
165
|
+
"The unique identifier for the revision in UUIDv4 format. Example: a312cb9c-7632-43c2-aa38-69b06aed56ca"
|
|
136
166
|
revision: UUID!
|
|
167
|
+
"The service owner code representing the organization (service owner) related to this dialog. Example: ske"
|
|
137
168
|
org: String!
|
|
169
|
+
"The service identifier for the service that the dialog is related to in URN-format. This corresponds to a service resource in the Altinn Resource Registry. Example: urn:altinn:resource:some-service-identifier"
|
|
138
170
|
serviceResource: String!
|
|
171
|
+
"The ServiceResource type, as defined in Altinn Resource Registry (see ResourceType)."
|
|
139
172
|
serviceResourceType: String!
|
|
173
|
+
"The party code representing the organization or person that the dialog belongs to in URN format. Example: urn:altinn:person:identifier-no:01125512345, urn:altinn:organization:identifier-no:912345678"
|
|
140
174
|
party: String!
|
|
175
|
+
"Advisory indicator of progress, represented as 1-100 percentage value. 100% representing a dialog that has come to a natural completion (successful or not)."
|
|
141
176
|
progress: Int
|
|
177
|
+
"Optional process identifier used to indicate a business process this dialog belongs to."
|
|
142
178
|
process: String
|
|
179
|
+
"Optional preceding process identifier to indicate the business process that preceded the process indicated in the 'Process' field. Cannot be set without also 'Process' being set."
|
|
143
180
|
precedingProcess: String
|
|
181
|
+
"Arbitrary string with a service-specific indicator of status, typically used to indicate a fine-grained state of the dialog to further specify the 'status' enum. Refer to the service-specific documentation provided by the service owner for details on the possible values (if in use)."
|
|
144
182
|
extendedStatus: String
|
|
183
|
+
"Arbitrary string with a service-specific reference to an external system or service. Refer to the service-specific documentation provided by the service owner for details (if in use)."
|
|
145
184
|
externalReference: String
|
|
185
|
+
"The date and time when the dialog becomes visible to the end user."
|
|
146
186
|
visibleFrom: DateTime
|
|
187
|
+
"The due date for the dialog. Dialogs past due date might be marked as such in frontends but will still be available. Example: 2022-12-31T23:59:59Z"
|
|
147
188
|
dueAt: DateTime
|
|
189
|
+
"The expiration date for the dialog. This is the last date when the dialog is available for the end user. After this date is passed, the dialog will be considered expired and no longer available for the end user in any API. If not supplied, the dialog will be considered to never expire. This field can be changed by the service owner after the dialog has been created. Example: 2022-12-31T23:59:59Z"
|
|
148
190
|
expiresAt: DateTime
|
|
191
|
+
"The date and time when the dialog was created. Example: 2022-12-31T23:59:59Z"
|
|
149
192
|
createdAt: DateTime!
|
|
193
|
+
"The date and time when the dialog was last updated. Example: 2022-12-31T23:59:59Z"
|
|
150
194
|
updatedAt: DateTime!
|
|
195
|
+
"The date and time when the dialog content was last updated. Example: 2022-12-31T23:59:59Z"
|
|
151
196
|
contentUpdatedAt: DateTime!
|
|
197
|
+
"The dialog token. May be used (if supported) against external URLs referred to in this dialog's apiActions, transmissions or attachments. It should also be used for front-channel embeds."
|
|
152
198
|
dialogToken: String
|
|
199
|
+
"The aggregated status of the dialog."
|
|
153
200
|
status: DialogStatus!
|
|
201
|
+
"Indicates whether the dialog contains content that has not been viewed or opened by the user yet."
|
|
154
202
|
hasUnopenedContent: Boolean!
|
|
203
|
+
"The number of transmissions sent by the service owner"
|
|
204
|
+
fromServiceOwnerTransmissionsCount: Int!
|
|
205
|
+
"The number of transmissions sent by a party representative"
|
|
206
|
+
fromPartyTransmissionsCount: Int!
|
|
155
207
|
"Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans"
|
|
156
208
|
isApiOnly: Boolean!
|
|
209
|
+
"The dialog unstructured text content."
|
|
157
210
|
content: Content!
|
|
211
|
+
"The attachments associated with the dialog (on an aggregate level)."
|
|
158
212
|
attachments: [Attachment!]!
|
|
213
|
+
"The GUI actions associated with the dialog. Should be used in browser-based interactive frontends."
|
|
159
214
|
guiActions: [GuiAction!]!
|
|
215
|
+
"The API actions associated with the dialog. Should be used in specialized, non-browser-based integrations."
|
|
160
216
|
apiActions: [ApiAction!]!
|
|
217
|
+
"An immutable list of activities associated with the dialog."
|
|
161
218
|
activities: [Activity!]!
|
|
219
|
+
"The list of seen log entries for the dialog newer than the dialog UpdatedAt date."
|
|
162
220
|
seenSinceLastUpdate: [SeenLog!]!
|
|
221
|
+
"The list of seen log entries for the dialog newer than the dialog ContentUpdatedAt date."
|
|
163
222
|
seenSinceLastContentUpdate: [SeenLog!]!
|
|
223
|
+
"The immutable list of transmissions associated with the dialog."
|
|
164
224
|
transmissions: [Transmission!]!
|
|
225
|
+
"Metadata about the dialog owned by end-users."
|
|
165
226
|
endUserContext: EndUserContext!
|
|
166
227
|
}
|
|
167
228
|
|
|
@@ -197,15 +258,25 @@ type EndUserContext {
|
|
|
197
258
|
}
|
|
198
259
|
|
|
199
260
|
type GuiAction {
|
|
261
|
+
"The unique identifier for the action in UUIDv7 format."
|
|
200
262
|
id: UUID!
|
|
263
|
+
"The action identifier for the action, corresponding to the 'action' attributeId used in the XACML service policy."
|
|
201
264
|
action: String!
|
|
265
|
+
"The fully qualified URL of the action, to which the user will be redirected when the action is triggered. Will be set to 'urn:dialogporten:unauthorized' if the user is not authorized to perform the action."
|
|
202
266
|
url: URL!
|
|
267
|
+
"Contains an authorization resource attributeId, that can used in custom authorization rules in the XACML service policy, which by default is the policy belonging to the service referred to by 'serviceResource' in the dialog. Can also be used to refer to other service policies."
|
|
203
268
|
authorizationAttribute: String
|
|
269
|
+
"Whether the user is authorized to perform the action."
|
|
204
270
|
isAuthorized: Boolean!
|
|
271
|
+
"Indicates whether the action results in the dialog being deleted. Used by frontends to implement custom UX for delete actions."
|
|
205
272
|
isDeleteDialogAction: Boolean!
|
|
273
|
+
"Indicates a priority for the action, making it possible for frontends to adapt GUI elements based on action priority."
|
|
206
274
|
priority: GuiActionPriority!
|
|
275
|
+
"The HTTP method that the frontend should use when redirecting the user."
|
|
207
276
|
httpMethod: HttpVerb!
|
|
277
|
+
"The title of the action, this should be short and in verb form."
|
|
208
278
|
title: [Localization!]!
|
|
279
|
+
"If there should be a prompt asking the user for confirmation before the action is executed, this field should contain the prompt text."
|
|
209
280
|
prompt: [Localization!]
|
|
210
281
|
}
|
|
211
282
|
|
|
@@ -226,35 +297,66 @@ type Queries @authorize(policy: "enduser") {
|
|
|
226
297
|
}
|
|
227
298
|
|
|
228
299
|
type SearchContent {
|
|
300
|
+
"The title of the dialog."
|
|
229
301
|
title: ContentValue!
|
|
302
|
+
"A short summary of the dialog and its current state."
|
|
230
303
|
summary: ContentValue
|
|
304
|
+
"Overridden sender name. If not supplied, assume 'org' as the sender name."
|
|
231
305
|
senderName: ContentValue
|
|
306
|
+
"Used as the human-readable label used to describe the 'ExtendedStatus' field."
|
|
232
307
|
extendedStatus: ContentValue
|
|
233
308
|
}
|
|
234
309
|
|
|
235
310
|
type SearchDialog {
|
|
311
|
+
"The unique identifier for the dialog in UUIDv7 format. Example: 01913cd5-784f-7d3b-abef-4c77b1f0972d"
|
|
236
312
|
id: UUID!
|
|
313
|
+
"The service owner code representing the organization (service owner) related to this dialog. Example: ske"
|
|
237
314
|
org: String!
|
|
315
|
+
"The service identifier for the service that the dialog is related to in URN-format. This corresponds to a service resource in the Altinn Resource Registry. Example: urn:altinn:resource:some-service-identifier"
|
|
238
316
|
serviceResource: String!
|
|
317
|
+
"The ServiceResource type, as defined in Altinn Resource Registry (see ResourceType)."
|
|
239
318
|
serviceResourceType: String!
|
|
319
|
+
"The party code representing the organization or person that the dialog belongs to in URN format. Example: urn:altinn:person:identifier-no:01125512345, urn:altinn:organization:identifier-no:912345678"
|
|
240
320
|
party: String!
|
|
321
|
+
"Advisory indicator of progress, represented as 1-100 percentage value. 100% representing a dialog that has come to a natural completion (successful or not)."
|
|
241
322
|
progress: Int
|
|
323
|
+
"Optional process identifier used to indicate a business process this dialog belongs to."
|
|
242
324
|
process: String
|
|
325
|
+
"Optional preceding process identifier to indicate the business process that preceded the process indicated in the 'Process' field. Cannot be set without also 'Process' being set."
|
|
243
326
|
precedingProcess: String
|
|
327
|
+
"The number of attachments in the dialog made available for browser-based frontends."
|
|
244
328
|
guiAttachmentCount: Int
|
|
329
|
+
"Arbitrary string with a service-specific indicator of status, typically used to indicate a fine-grained state of the dialog to further specify the 'status' enum. Refer to the service-specific documentation provided by the service owner for details on the possible values (if in use)."
|
|
245
330
|
extendedStatus: String
|
|
331
|
+
"Arbitrary string with a service-specific reference to an external system or service. Refer to the service-specific documentation provided by the service owner for details (if in use)."
|
|
332
|
+
externalReference: String
|
|
333
|
+
"The date and time when the dialog was created. Example: 2022-12-31T23:59:59Z"
|
|
246
334
|
createdAt: DateTime!
|
|
335
|
+
"The date and time when the dialog was last updated. Example: 2022-12-31T23:59:59Z"
|
|
247
336
|
updatedAt: DateTime!
|
|
337
|
+
"The date and time when the dialog content was last updated. Example: 2022-12-31T23:59:59Z"
|
|
248
338
|
contentUpdatedAt: DateTime!
|
|
339
|
+
"The due date for the dialog. This is the last date when the dialog is expected to be completed. Example: 2022-12-31T23:59:59Z"
|
|
249
340
|
dueAt: DateTime
|
|
341
|
+
"The aggregated status of the dialog."
|
|
250
342
|
status: DialogStatus!
|
|
343
|
+
"Indicates whether the dialog contains content that has not been viewed or opened by the user yet."
|
|
251
344
|
hasUnopenedContent: Boolean!
|
|
252
345
|
"Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans"
|
|
253
346
|
isApiOnly: Boolean!
|
|
347
|
+
"The number of transmissions sent by the service owner"
|
|
348
|
+
fromServiceOwnerTransmissionsCount: Int!
|
|
349
|
+
"The number of transmissions sent by a party representative"
|
|
350
|
+
fromPartyTransmissionsCount: Int!
|
|
351
|
+
"The latest entry in the dialog's activity log."
|
|
254
352
|
latestActivity: Activity
|
|
353
|
+
"The content of the dialog in search results."
|
|
255
354
|
content: SearchContent!
|
|
355
|
+
"The list of seen log entries for the dialog newer than the dialog UpdatedAt date."
|
|
256
356
|
seenSinceLastUpdate: [SeenLog!]!
|
|
357
|
+
"The list of seen log entries for the dialog newer than the dialog ContentUpdatedAt date."
|
|
257
358
|
seenSinceLastContentUpdate: [SeenLog!]!
|
|
359
|
+
"Metadata about the dialog owned by end-users."
|
|
258
360
|
endUserContext: EndUserContext!
|
|
259
361
|
}
|
|
260
362
|
|
|
@@ -295,6 +397,7 @@ type SeenLog {
|
|
|
295
397
|
id: UUID!
|
|
296
398
|
seenAt: DateTime!
|
|
297
399
|
seenBy: Actor!
|
|
400
|
+
isViaServiceOwner: Boolean
|
|
298
401
|
isCurrentEndUser: Boolean!
|
|
299
402
|
}
|
|
300
403
|
|
|
@@ -313,21 +416,36 @@ type Subscriptions {
|
|
|
313
416
|
}
|
|
314
417
|
|
|
315
418
|
type Transmission {
|
|
419
|
+
"The unique identifier for the transmission in UUIDv7 format."
|
|
316
420
|
id: UUID!
|
|
421
|
+
"The date and time when the transmission was created."
|
|
317
422
|
createdAt: DateTime!
|
|
423
|
+
"Contains an authorization resource attributeId, that can used in custom authorization rules in the XACML service policy, which by default is the policy belonging to the service referred to by 'serviceResource' in the dialog. Can also be used to refer to other service policies. Example: mycustomresource, urn:altinn:subresource:mycustomresource, urn:altinn:task:Task_1, urn:altinn:resource:some-other-service-identifier"
|
|
318
424
|
authorizationAttribute: String
|
|
425
|
+
"Flag indicating if the authenticated user is authorized for this transmission. If not, embedded content and the attachments will not be available."
|
|
319
426
|
isAuthorized: Boolean!
|
|
427
|
+
"Arbitrary URI\/URN describing a service-specific transmission type. Refer to the service-specific documentation provided by the service owner for details (if in use)."
|
|
320
428
|
extendedType: URL
|
|
429
|
+
"Reference to any other transmission that this transmission is related to."
|
|
321
430
|
relatedTransmissionId: UUID
|
|
431
|
+
"The type of transmission."
|
|
322
432
|
type: TransmissionType!
|
|
433
|
+
"The actor that sent the transmission."
|
|
323
434
|
sender: Actor!
|
|
435
|
+
"Indicates whether the dialog transmission has been opened."
|
|
436
|
+
isOpened: Boolean!
|
|
437
|
+
"The transmission unstructured text content."
|
|
324
438
|
content: TransmissionContent!
|
|
439
|
+
"The transmission-level attachments."
|
|
325
440
|
attachments: [Attachment!]!
|
|
326
441
|
}
|
|
327
442
|
|
|
328
443
|
type TransmissionContent {
|
|
444
|
+
"The transmission title."
|
|
329
445
|
title: ContentValue!
|
|
446
|
+
"The transmission summary."
|
|
330
447
|
summary: ContentValue
|
|
448
|
+
"Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL."
|
|
331
449
|
contentReference: ContentValue
|
|
332
450
|
}
|
|
333
451
|
|
|
@@ -531,4 +649,4 @@ scalar DateTime @specifiedBy(url: "https:\/\/www.graphql-scalars.com\/date-time"
|
|
|
531
649
|
|
|
532
650
|
scalar URL @specifiedBy(url: "https:\/\/tools.ietf.org\/html\/rfc3986")
|
|
533
651
|
|
|
534
|
-
scalar UUID @specifiedBy(url: "https:\/\/tools.ietf.org\/html\/rfc4122")
|
|
652
|
+
scalar UUID @specifiedBy(url: "https:\/\/tools.ietf.org\/html\/rfc4122")
|
package/src/index.js
CHANGED
|
@@ -37,36 +37,58 @@ type Actor {
|
|
|
37
37
|
}
|
|
38
38
|
|
|
39
39
|
type ApiAction {
|
|
40
|
+
"The unique identifier for the action in UUIDv7 format."
|
|
40
41
|
id: UUID!
|
|
42
|
+
"String identifier for the action, corresponding to the 'action' attributeId used in the XACML service policy, which by default is the policy belonging to the service referred to by 'serviceResource' in the dialog."
|
|
41
43
|
action: String!
|
|
44
|
+
"Contains an authorization resource attributeId, that can used in custom authorization rules in the XACML service policy, which by default is the policy belonging to the service referred to by 'serviceResource' in the dialog. Can also be used to refer to other service policies."
|
|
42
45
|
authorizationAttribute: String
|
|
46
|
+
"True if the authenticated user is authorized for this action. If not, the action will not be available and all endpoints will be replaced with a fixed placeholder."
|
|
43
47
|
isAuthorized: Boolean!
|
|
48
|
+
"The logical name of the operation the API action refers to."
|
|
44
49
|
name: String
|
|
50
|
+
"The endpoints associated with the action."
|
|
45
51
|
endpoints: [ApiActionEndpoint!]!
|
|
46
52
|
}
|
|
47
53
|
|
|
48
54
|
type ApiActionEndpoint {
|
|
55
|
+
"The unique identifier for the endpoint in UUIDv7 format."
|
|
49
56
|
id: UUID!
|
|
57
|
+
"Arbitrary string indicating the version of the endpoint. Consult the service-specific documentation provided by the service owner for details (if in use)."
|
|
50
58
|
version: String
|
|
59
|
+
"The fully qualified URL of the API endpoint. Will be set to 'urn:dialogporten:unauthorized' if the user is not authorized to perform the action."
|
|
51
60
|
url: URL!
|
|
61
|
+
"The HTTP method that the endpoint expects for this action."
|
|
52
62
|
httpMethod: HttpVerb!
|
|
63
|
+
"Link to service provider documentation for the endpoint. Used for service owners to provide documentation for integrators. Should be a URL to a human-readable page."
|
|
53
64
|
documentationUrl: URL
|
|
65
|
+
"Link to the request schema for the endpoint. Used by service owners to provide documentation for integrators. Dialogporten will not validate information on this endpoint."
|
|
54
66
|
requestSchema: URL
|
|
67
|
+
"Link to the response schema for the endpoint. Used for service owners to provide documentation for integrators. Dialogporten will not validate information on this endpoint."
|
|
55
68
|
responseSchema: URL
|
|
69
|
+
"Boolean indicating if the endpoint is deprecated. Integrators should migrate to endpoints with a higher version."
|
|
56
70
|
deprecated: Boolean!
|
|
71
|
+
"Date and time when the service owner has indicated that endpoint will no longer function. Only set if the endpoint is deprecated. Dialogporten will not enforce this date."
|
|
57
72
|
sunsetAt: DateTime
|
|
58
73
|
}
|
|
59
74
|
|
|
60
75
|
type Attachment {
|
|
76
|
+
"The unique identifier for the attachment in UUIDv7 format."
|
|
61
77
|
id: UUID!
|
|
78
|
+
"The display name of the attachment that should be used in GUIs."
|
|
62
79
|
displayName: [Localization!]!
|
|
80
|
+
"The URLs associated with the attachment, each referring to a different representation of the attachment."
|
|
63
81
|
urls: [AttachmentUrl!]!
|
|
64
82
|
}
|
|
65
83
|
|
|
66
84
|
type AttachmentUrl {
|
|
85
|
+
"The unique identifier for the attachment URL in UUIDv7 format."
|
|
67
86
|
id: UUID!
|
|
87
|
+
"The fully qualified URL of the attachment."
|
|
68
88
|
url: URL!
|
|
89
|
+
"The media type of the attachment."
|
|
69
90
|
mediaType: String
|
|
91
|
+
"What type of consumer the URL is intended for."
|
|
70
92
|
consumerType: AttachmentUrlConsumer!
|
|
71
93
|
}
|
|
72
94
|
|
|
@@ -118,11 +140,17 @@ type BulkSetSystemLabelValidationError implements BulkSetSystemLabelError {
|
|
|
118
140
|
}
|
|
119
141
|
|
|
120
142
|
type Content {
|
|
143
|
+
"The title of the dialog."
|
|
121
144
|
title: ContentValue!
|
|
145
|
+
"A short summary of the dialog and its current state."
|
|
122
146
|
summary: ContentValue
|
|
147
|
+
"Overridden sender name. If not supplied, assume 'org' as the sender name."
|
|
123
148
|
senderName: ContentValue
|
|
149
|
+
"Additional information about the dialog, this may contain Markdown."
|
|
124
150
|
additionalInfo: ContentValue
|
|
151
|
+
"Used as the human-readable label used to describe the 'ExtendedStatus' field."
|
|
125
152
|
extendedStatus: ContentValue
|
|
153
|
+
"Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL."
|
|
126
154
|
mainContentReference: ContentValue
|
|
127
155
|
}
|
|
128
156
|
|
|
@@ -132,36 +160,69 @@ type ContentValue {
|
|
|
132
160
|
}
|
|
133
161
|
|
|
134
162
|
type Dialog {
|
|
163
|
+
"The unique identifier for the dialog in UUIDv7 format. Example: 01913cd5-784f-7d3b-abef-4c77b1f0972d"
|
|
135
164
|
id: UUID!
|
|
165
|
+
"The unique identifier for the revision in UUIDv4 format. Example: a312cb9c-7632-43c2-aa38-69b06aed56ca"
|
|
136
166
|
revision: UUID!
|
|
167
|
+
"The service owner code representing the organization (service owner) related to this dialog. Example: ske"
|
|
137
168
|
org: String!
|
|
169
|
+
"The service identifier for the service that the dialog is related to in URN-format. This corresponds to a service resource in the Altinn Resource Registry. Example: urn:altinn:resource:some-service-identifier"
|
|
138
170
|
serviceResource: String!
|
|
171
|
+
"The ServiceResource type, as defined in Altinn Resource Registry (see ResourceType)."
|
|
139
172
|
serviceResourceType: String!
|
|
173
|
+
"The party code representing the organization or person that the dialog belongs to in URN format. Example: urn:altinn:person:identifier-no:01125512345, urn:altinn:organization:identifier-no:912345678"
|
|
140
174
|
party: String!
|
|
175
|
+
"Advisory indicator of progress, represented as 1-100 percentage value. 100% representing a dialog that has come to a natural completion (successful or not)."
|
|
141
176
|
progress: Int
|
|
177
|
+
"Optional process identifier used to indicate a business process this dialog belongs to."
|
|
142
178
|
process: String
|
|
179
|
+
"Optional preceding process identifier to indicate the business process that preceded the process indicated in the 'Process' field. Cannot be set without also 'Process' being set."
|
|
143
180
|
precedingProcess: String
|
|
181
|
+
"Arbitrary string with a service-specific indicator of status, typically used to indicate a fine-grained state of the dialog to further specify the 'status' enum. Refer to the service-specific documentation provided by the service owner for details on the possible values (if in use)."
|
|
144
182
|
extendedStatus: String
|
|
183
|
+
"Arbitrary string with a service-specific reference to an external system or service. Refer to the service-specific documentation provided by the service owner for details (if in use)."
|
|
145
184
|
externalReference: String
|
|
185
|
+
"The date and time when the dialog becomes visible to the end user."
|
|
146
186
|
visibleFrom: DateTime
|
|
187
|
+
"The due date for the dialog. Dialogs past due date might be marked as such in frontends but will still be available. Example: 2022-12-31T23:59:59Z"
|
|
147
188
|
dueAt: DateTime
|
|
189
|
+
"The expiration date for the dialog. This is the last date when the dialog is available for the end user. After this date is passed, the dialog will be considered expired and no longer available for the end user in any API. If not supplied, the dialog will be considered to never expire. This field can be changed by the service owner after the dialog has been created. Example: 2022-12-31T23:59:59Z"
|
|
148
190
|
expiresAt: DateTime
|
|
191
|
+
"The date and time when the dialog was created. Example: 2022-12-31T23:59:59Z"
|
|
149
192
|
createdAt: DateTime!
|
|
193
|
+
"The date and time when the dialog was last updated. Example: 2022-12-31T23:59:59Z"
|
|
150
194
|
updatedAt: DateTime!
|
|
195
|
+
"The date and time when the dialog content was last updated. Example: 2022-12-31T23:59:59Z"
|
|
151
196
|
contentUpdatedAt: DateTime!
|
|
197
|
+
"The dialog token. May be used (if supported) against external URLs referred to in this dialog's apiActions, transmissions or attachments. It should also be used for front-channel embeds."
|
|
152
198
|
dialogToken: String
|
|
199
|
+
"The aggregated status of the dialog."
|
|
153
200
|
status: DialogStatus!
|
|
201
|
+
"Indicates whether the dialog contains content that has not been viewed or opened by the user yet."
|
|
154
202
|
hasUnopenedContent: Boolean!
|
|
203
|
+
"The number of transmissions sent by the service owner"
|
|
204
|
+
fromServiceOwnerTransmissionsCount: Int!
|
|
205
|
+
"The number of transmissions sent by a party representative"
|
|
206
|
+
fromPartyTransmissionsCount: Int!
|
|
155
207
|
"Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans"
|
|
156
208
|
isApiOnly: Boolean!
|
|
209
|
+
"The dialog unstructured text content."
|
|
157
210
|
content: Content!
|
|
211
|
+
"The attachments associated with the dialog (on an aggregate level)."
|
|
158
212
|
attachments: [Attachment!]!
|
|
213
|
+
"The GUI actions associated with the dialog. Should be used in browser-based interactive frontends."
|
|
159
214
|
guiActions: [GuiAction!]!
|
|
215
|
+
"The API actions associated with the dialog. Should be used in specialized, non-browser-based integrations."
|
|
160
216
|
apiActions: [ApiAction!]!
|
|
217
|
+
"An immutable list of activities associated with the dialog."
|
|
161
218
|
activities: [Activity!]!
|
|
219
|
+
"The list of seen log entries for the dialog newer than the dialog UpdatedAt date."
|
|
162
220
|
seenSinceLastUpdate: [SeenLog!]!
|
|
221
|
+
"The list of seen log entries for the dialog newer than the dialog ContentUpdatedAt date."
|
|
163
222
|
seenSinceLastContentUpdate: [SeenLog!]!
|
|
223
|
+
"The immutable list of transmissions associated with the dialog."
|
|
164
224
|
transmissions: [Transmission!]!
|
|
225
|
+
"Metadata about the dialog owned by end-users."
|
|
165
226
|
endUserContext: EndUserContext!
|
|
166
227
|
}
|
|
167
228
|
|
|
@@ -197,15 +258,25 @@ type EndUserContext {
|
|
|
197
258
|
}
|
|
198
259
|
|
|
199
260
|
type GuiAction {
|
|
261
|
+
"The unique identifier for the action in UUIDv7 format."
|
|
200
262
|
id: UUID!
|
|
263
|
+
"The action identifier for the action, corresponding to the 'action' attributeId used in the XACML service policy."
|
|
201
264
|
action: String!
|
|
265
|
+
"The fully qualified URL of the action, to which the user will be redirected when the action is triggered. Will be set to 'urn:dialogporten:unauthorized' if the user is not authorized to perform the action."
|
|
202
266
|
url: URL!
|
|
267
|
+
"Contains an authorization resource attributeId, that can used in custom authorization rules in the XACML service policy, which by default is the policy belonging to the service referred to by 'serviceResource' in the dialog. Can also be used to refer to other service policies."
|
|
203
268
|
authorizationAttribute: String
|
|
269
|
+
"Whether the user is authorized to perform the action."
|
|
204
270
|
isAuthorized: Boolean!
|
|
271
|
+
"Indicates whether the action results in the dialog being deleted. Used by frontends to implement custom UX for delete actions."
|
|
205
272
|
isDeleteDialogAction: Boolean!
|
|
273
|
+
"Indicates a priority for the action, making it possible for frontends to adapt GUI elements based on action priority."
|
|
206
274
|
priority: GuiActionPriority!
|
|
275
|
+
"The HTTP method that the frontend should use when redirecting the user."
|
|
207
276
|
httpMethod: HttpVerb!
|
|
277
|
+
"The title of the action, this should be short and in verb form."
|
|
208
278
|
title: [Localization!]!
|
|
279
|
+
"If there should be a prompt asking the user for confirmation before the action is executed, this field should contain the prompt text."
|
|
209
280
|
prompt: [Localization!]
|
|
210
281
|
}
|
|
211
282
|
|
|
@@ -226,35 +297,66 @@ type Queries @authorize(policy: "enduser") {
|
|
|
226
297
|
}
|
|
227
298
|
|
|
228
299
|
type SearchContent {
|
|
300
|
+
"The title of the dialog."
|
|
229
301
|
title: ContentValue!
|
|
302
|
+
"A short summary of the dialog and its current state."
|
|
230
303
|
summary: ContentValue
|
|
304
|
+
"Overridden sender name. If not supplied, assume 'org' as the sender name."
|
|
231
305
|
senderName: ContentValue
|
|
306
|
+
"Used as the human-readable label used to describe the 'ExtendedStatus' field."
|
|
232
307
|
extendedStatus: ContentValue
|
|
233
308
|
}
|
|
234
309
|
|
|
235
310
|
type SearchDialog {
|
|
311
|
+
"The unique identifier for the dialog in UUIDv7 format. Example: 01913cd5-784f-7d3b-abef-4c77b1f0972d"
|
|
236
312
|
id: UUID!
|
|
313
|
+
"The service owner code representing the organization (service owner) related to this dialog. Example: ske"
|
|
237
314
|
org: String!
|
|
315
|
+
"The service identifier for the service that the dialog is related to in URN-format. This corresponds to a service resource in the Altinn Resource Registry. Example: urn:altinn:resource:some-service-identifier"
|
|
238
316
|
serviceResource: String!
|
|
317
|
+
"The ServiceResource type, as defined in Altinn Resource Registry (see ResourceType)."
|
|
239
318
|
serviceResourceType: String!
|
|
319
|
+
"The party code representing the organization or person that the dialog belongs to in URN format. Example: urn:altinn:person:identifier-no:01125512345, urn:altinn:organization:identifier-no:912345678"
|
|
240
320
|
party: String!
|
|
321
|
+
"Advisory indicator of progress, represented as 1-100 percentage value. 100% representing a dialog that has come to a natural completion (successful or not)."
|
|
241
322
|
progress: Int
|
|
323
|
+
"Optional process identifier used to indicate a business process this dialog belongs to."
|
|
242
324
|
process: String
|
|
325
|
+
"Optional preceding process identifier to indicate the business process that preceded the process indicated in the 'Process' field. Cannot be set without also 'Process' being set."
|
|
243
326
|
precedingProcess: String
|
|
327
|
+
"The number of attachments in the dialog made available for browser-based frontends."
|
|
244
328
|
guiAttachmentCount: Int
|
|
329
|
+
"Arbitrary string with a service-specific indicator of status, typically used to indicate a fine-grained state of the dialog to further specify the 'status' enum. Refer to the service-specific documentation provided by the service owner for details on the possible values (if in use)."
|
|
245
330
|
extendedStatus: String
|
|
331
|
+
"Arbitrary string with a service-specific reference to an external system or service. Refer to the service-specific documentation provided by the service owner for details (if in use)."
|
|
332
|
+
externalReference: String
|
|
333
|
+
"The date and time when the dialog was created. Example: 2022-12-31T23:59:59Z"
|
|
246
334
|
createdAt: DateTime!
|
|
335
|
+
"The date and time when the dialog was last updated. Example: 2022-12-31T23:59:59Z"
|
|
247
336
|
updatedAt: DateTime!
|
|
337
|
+
"The date and time when the dialog content was last updated. Example: 2022-12-31T23:59:59Z"
|
|
248
338
|
contentUpdatedAt: DateTime!
|
|
339
|
+
"The due date for the dialog. This is the last date when the dialog is expected to be completed. Example: 2022-12-31T23:59:59Z"
|
|
249
340
|
dueAt: DateTime
|
|
341
|
+
"The aggregated status of the dialog."
|
|
250
342
|
status: DialogStatus!
|
|
343
|
+
"Indicates whether the dialog contains content that has not been viewed or opened by the user yet."
|
|
251
344
|
hasUnopenedContent: Boolean!
|
|
252
345
|
"Indicates if this dialog is intended for API consumption only and should not be shown in frontends aimed at humans"
|
|
253
346
|
isApiOnly: Boolean!
|
|
347
|
+
"The number of transmissions sent by the service owner"
|
|
348
|
+
fromServiceOwnerTransmissionsCount: Int!
|
|
349
|
+
"The number of transmissions sent by a party representative"
|
|
350
|
+
fromPartyTransmissionsCount: Int!
|
|
351
|
+
"The latest entry in the dialog's activity log."
|
|
254
352
|
latestActivity: Activity
|
|
353
|
+
"The content of the dialog in search results."
|
|
255
354
|
content: SearchContent!
|
|
355
|
+
"The list of seen log entries for the dialog newer than the dialog UpdatedAt date."
|
|
256
356
|
seenSinceLastUpdate: [SeenLog!]!
|
|
357
|
+
"The list of seen log entries for the dialog newer than the dialog ContentUpdatedAt date."
|
|
257
358
|
seenSinceLastContentUpdate: [SeenLog!]!
|
|
359
|
+
"Metadata about the dialog owned by end-users."
|
|
258
360
|
endUserContext: EndUserContext!
|
|
259
361
|
}
|
|
260
362
|
|
|
@@ -295,6 +397,7 @@ type SeenLog {
|
|
|
295
397
|
id: UUID!
|
|
296
398
|
seenAt: DateTime!
|
|
297
399
|
seenBy: Actor!
|
|
400
|
+
isViaServiceOwner: Boolean
|
|
298
401
|
isCurrentEndUser: Boolean!
|
|
299
402
|
}
|
|
300
403
|
|
|
@@ -313,21 +416,36 @@ type Subscriptions {
|
|
|
313
416
|
}
|
|
314
417
|
|
|
315
418
|
type Transmission {
|
|
419
|
+
"The unique identifier for the transmission in UUIDv7 format."
|
|
316
420
|
id: UUID!
|
|
421
|
+
"The date and time when the transmission was created."
|
|
317
422
|
createdAt: DateTime!
|
|
423
|
+
"Contains an authorization resource attributeId, that can used in custom authorization rules in the XACML service policy, which by default is the policy belonging to the service referred to by 'serviceResource' in the dialog. Can also be used to refer to other service policies. Example: mycustomresource, urn:altinn:subresource:mycustomresource, urn:altinn:task:Task_1, urn:altinn:resource:some-other-service-identifier"
|
|
318
424
|
authorizationAttribute: String
|
|
425
|
+
"Flag indicating if the authenticated user is authorized for this transmission. If not, embedded content and the attachments will not be available."
|
|
319
426
|
isAuthorized: Boolean!
|
|
427
|
+
"Arbitrary URI\/URN describing a service-specific transmission type. Refer to the service-specific documentation provided by the service owner for details (if in use)."
|
|
320
428
|
extendedType: URL
|
|
429
|
+
"Reference to any other transmission that this transmission is related to."
|
|
321
430
|
relatedTransmissionId: UUID
|
|
431
|
+
"The type of transmission."
|
|
322
432
|
type: TransmissionType!
|
|
433
|
+
"The actor that sent the transmission."
|
|
323
434
|
sender: Actor!
|
|
435
|
+
"Indicates whether the dialog transmission has been opened."
|
|
436
|
+
isOpened: Boolean!
|
|
437
|
+
"The transmission unstructured text content."
|
|
324
438
|
content: TransmissionContent!
|
|
439
|
+
"The transmission-level attachments."
|
|
325
440
|
attachments: [Attachment!]!
|
|
326
441
|
}
|
|
327
442
|
|
|
328
443
|
type TransmissionContent {
|
|
444
|
+
"The transmission title."
|
|
329
445
|
title: ContentValue!
|
|
446
|
+
"The transmission summary."
|
|
330
447
|
summary: ContentValue
|
|
448
|
+
"Front-channel embedded content. Used to dynamically embed content in the frontend from an external URL."
|
|
331
449
|
contentReference: ContentValue
|
|
332
450
|
}
|
|
333
451
|
|
package/swagger.verified.json
CHANGED
|
@@ -618,6 +618,16 @@
|
|
|
618
618
|
"nullable": true,
|
|
619
619
|
"type": "string"
|
|
620
620
|
},
|
|
621
|
+
"fromPartyTransmissionsCount": {
|
|
622
|
+
"description": "The number of transmissions sent by a party representative",
|
|
623
|
+
"format": "int32",
|
|
624
|
+
"type": "integer"
|
|
625
|
+
},
|
|
626
|
+
"fromServiceOwnerTransmissionsCount": {
|
|
627
|
+
"description": "The number of transmissions sent by a service owner",
|
|
628
|
+
"format": "int32",
|
|
629
|
+
"type": "integer"
|
|
630
|
+
},
|
|
621
631
|
"guiActions": {
|
|
622
632
|
"description": "The GUI actions associated with the dialog. Should be used in browser-based interactive frontends.",
|
|
623
633
|
"items": {
|
|
@@ -681,7 +691,7 @@
|
|
|
681
691
|
"type": "array"
|
|
682
692
|
},
|
|
683
693
|
"seenSinceLastUpdate": {
|
|
684
|
-
"description": "The list of seen log entries for the dialog newer than the dialog
|
|
694
|
+
"description": "The list of seen log entries for the dialog newer than the dialog UpdatedAt date.",
|
|
685
695
|
"items": {
|
|
686
696
|
"$ref": "#/components/schemas/V1EndUserDialogsQueriesGet_DialogSeenLog"
|
|
687
697
|
},
|
|
@@ -1108,7 +1118,6 @@
|
|
|
1108
1118
|
},
|
|
1109
1119
|
"isOpened": {
|
|
1110
1120
|
"description": "Indicates whether the dialog transmission has been opened.",
|
|
1111
|
-
"nullable": true,
|
|
1112
1121
|
"type": "boolean"
|
|
1113
1122
|
},
|
|
1114
1123
|
"relatedTransmissionId": {
|
|
@@ -1536,6 +1545,16 @@
|
|
|
1536
1545
|
"nullable": true,
|
|
1537
1546
|
"type": "string"
|
|
1538
1547
|
},
|
|
1548
|
+
"fromPartyTransmissionsCount": {
|
|
1549
|
+
"description": "The number of transmissions sent by a party representative",
|
|
1550
|
+
"format": "int32",
|
|
1551
|
+
"type": "integer"
|
|
1552
|
+
},
|
|
1553
|
+
"fromServiceOwnerTransmissionsCount": {
|
|
1554
|
+
"description": "The number of transmissions sent by the service owner",
|
|
1555
|
+
"format": "int32",
|
|
1556
|
+
"type": "integer"
|
|
1557
|
+
},
|
|
1539
1558
|
"guiAttachmentCount": {
|
|
1540
1559
|
"description": "The number of attachments in the dialog made available for browser-based frontends.",
|
|
1541
1560
|
"format": "int32",
|
|
@@ -1600,7 +1619,7 @@
|
|
|
1600
1619
|
"type": "array"
|
|
1601
1620
|
},
|
|
1602
1621
|
"seenSinceLastUpdate": {
|
|
1603
|
-
"description": "The list of seen log entries for the dialog newer than the dialog
|
|
1622
|
+
"description": "The list of seen log entries for the dialog newer than the dialog UpdatedAt date.",
|
|
1604
1623
|
"items": {
|
|
1605
1624
|
"$ref": "#/components/schemas/V1EndUserDialogsQueriesSearch_DialogSeenLog"
|
|
1606
1625
|
},
|
|
@@ -3767,6 +3786,16 @@
|
|
|
3767
3786
|
"nullable": true,
|
|
3768
3787
|
"type": "string"
|
|
3769
3788
|
},
|
|
3789
|
+
"fromPartyTransmissionsCount": {
|
|
3790
|
+
"description": "The number of transmissions sent by a party representative",
|
|
3791
|
+
"format": "int32",
|
|
3792
|
+
"type": "integer"
|
|
3793
|
+
},
|
|
3794
|
+
"fromServiceOwnerTransmissionsCount": {
|
|
3795
|
+
"description": "The number of transmissions sent by the service owner",
|
|
3796
|
+
"format": "int32",
|
|
3797
|
+
"type": "integer"
|
|
3798
|
+
},
|
|
3770
3799
|
"guiActions": {
|
|
3771
3800
|
"description": "The GUI actions associated with the dialog. Should be used in browser-based interactive frontends.",
|
|
3772
3801
|
"items": {
|
|
@@ -3843,7 +3872,7 @@
|
|
|
3843
3872
|
"type": "array"
|
|
3844
3873
|
},
|
|
3845
3874
|
"seenSinceLastUpdate": {
|
|
3846
|
-
"description": "The list of seen log entries for the dialog newer than the dialog
|
|
3875
|
+
"description": "The list of seen log entries for the dialog newer than the dialog UpdatedAt date.",
|
|
3847
3876
|
"items": {
|
|
3848
3877
|
"$ref": "#/components/schemas/V1ServiceOwnerDialogsQueriesGet_DialogSeenLog"
|
|
3849
3878
|
},
|
|
@@ -4321,7 +4350,6 @@
|
|
|
4321
4350
|
},
|
|
4322
4351
|
"isOpened": {
|
|
4323
4352
|
"description": "Indicates whether the dialog transmission has been opened.",
|
|
4324
|
-
"nullable": true,
|
|
4325
4353
|
"type": "boolean"
|
|
4326
4354
|
},
|
|
4327
4355
|
"relatedTransmissionId": {
|
|
@@ -4804,6 +4832,16 @@
|
|
|
4804
4832
|
"nullable": true,
|
|
4805
4833
|
"type": "string"
|
|
4806
4834
|
},
|
|
4835
|
+
"fromPartyTransmissionsCount": {
|
|
4836
|
+
"description": "The number of transmissions sent by a party representative",
|
|
4837
|
+
"format": "int32",
|
|
4838
|
+
"type": "integer"
|
|
4839
|
+
},
|
|
4840
|
+
"fromServiceOwnerTransmissionsCount": {
|
|
4841
|
+
"description": "The number of transmissions sent by a service owner",
|
|
4842
|
+
"format": "int32",
|
|
4843
|
+
"type": "integer"
|
|
4844
|
+
},
|
|
4807
4845
|
"guiAttachmentCount": {
|
|
4808
4846
|
"description": "The number of attachments in the dialog made available for browser-based frontends.",
|
|
4809
4847
|
"format": "int32",
|
|
@@ -4874,7 +4912,7 @@
|
|
|
4874
4912
|
"type": "array"
|
|
4875
4913
|
},
|
|
4876
4914
|
"seenSinceLastUpdate": {
|
|
4877
|
-
"description": "The list of seen log entries for the dialog newer than the dialog
|
|
4915
|
+
"description": "The list of seen log entries for the dialog newer than the dialog UpdatedAt date.",
|
|
4878
4916
|
"items": {
|
|
4879
4917
|
"$ref": "#/components/schemas/V1ServiceOwnerDialogsQueriesSearch_DialogSeenLog"
|
|
4880
4918
|
},
|
|
@@ -8520,4 +8558,4 @@
|
|
|
8520
8558
|
}
|
|
8521
8559
|
}
|
|
8522
8560
|
}
|
|
8523
|
-
}
|
|
8561
|
+
}
|