GPS Illustration API (1.0.0)

Download OpenAPI specification:Download

GPS API for running Illustrations. You can generate a sample request in the Illustration System via Tools>Download API Requests

Authentication

bearerHttpAuth

JWT token sent as bearer token

Security Scheme Type	HTTP
HTTP Authorization Scheme	bearer
Bearer format	"JWT"

Post Illustrations.

Post Illustrations

Authorizations:

bearerHttpAuth (admin)

Request Body schema: application/json

	Array of objects (IllustrationApiRequest)
	Array of objects (IllustrationApiResponse)
	Array of objects (IllustrationApiError)

Responses

Request samples

Payload

Content type

application/json

{"IllustrationApiRequest": [{"Fields": [{"Name": "ExecBonus.BonusAmount",
"Value": "{[0.00][][][][1][R-1]}"
}
],
"Profile": [{"CaseInfo": [{"Company": "WELIS",
"Version": "0.31",
"CaseKey": "5454"
}
],
"UseDefaultInput": true,
"InstallGroup": "Home Office",
"SelectedOutputTypes": ["Values"
],
"MessageId": "string"
}
]
}
],
"IllustrationApiResponse": [{"Illustration": [{"Status": "string",
"MessageLog": "string",
"DebugMessages": [{"Label": "string",
"Value": "string"
}
],
"CaseId": "string",
"Reports": [{"Name": "string",
"Description": "string",
"Scalars": [{"Name": "string",
"Description": "string",
"Value": "string"
}
],
"Vectors": [{"Name": "string",
"Description": "string",
"Value": ["string"
]
}
]
}
]
}
]
}
],
"IllustrationApiError": [{"Status": "string",
"Message": "string"
}
]
}

Response samples