aboutsummaryrefslogtreecommitdiffstats
path: root/vid-app-common/src/main/resources/json/mso/requestInfo
blob: 5fcf74c7c1cc6a907da8664a51250f03abfe1919 (plain)
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
{
	"$schema": "http://json-schema.org/draft-04/schema#",
	"description": "fields providing general context information for the request",
	"properties": {
		"billingAccountNumber": {
			"description": "billing account associated with the model being operated on",
			"type": "string"
		},
		"callbackUrl": {
			"description": "client URL to use for asynchronous responses",
			"type": "string"
		},
		"correlator": {
			"description": "Optional correlationId for async callback requests",
			"type": "string"
		},
		"instanceName": {
			"description": "Client provided name for the instance being operated on by the operation (note: not guaranteed to be unique)",
			"type": "string"
		},
		"orderNumber": {
			"description": "reference to an order",
			"type": "string"
		},
		"orderVersion": {
			"description": "order version number",
			"type": "number"
		},
		"productFamilyId": {
			"description": "UUID for the product family associated with the model being operated on",
			"type": "string"
		},
		"source": {
			"description": "source of the request--not authoritative--actual source revealed via authentication",
			"type": "string"
		},
		"suppressRollback": {
			"description": "true or false boolean indicating whether rollbacks should be suppressed on failures",
			"type": "boolean"
		},
		"responseValue": {
			"description": "Is the user selected value based on the validResponses list provided to complete the manual task",
			"type": "string"
		},
		"requestorId": {
			"description": "The id of the person who initiated the completion request",
			"type": "string"
		}
	},

	"type": "object"
}