Inspect a checkpoint
post
https://{your_site_interface}/opa-hub/api/12.2.35/checkpointInspect
This operation will inspect a given checkpoint.
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object
-
checkpoint(required): string
(byte)
Example:
QmFzZS02NCBkYXRhLg==
Security
-
Authorization: apiKey
Type:
apiKey
Description:Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
-
oauth2_opa: oauth2
Type:
oauth2
Description:POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.
Response
Supported Media Types
- application/json
200 Response
The checkpoint was successfully inspected.
Root Schema : checkpointInspect
Type:
Show Source
object
-
attachments: array
attachments
Read Only:
true
Contains a flat array of all the attachments in the checkpoint. -
dataModel: object
checkpointInspectDataModel
-
instanceData: object
checkpointInspectInstanceData
Additional Properties Allowed:
true
-
productVersion: string
Read Only:
true
The product version in which this checkpoint was created. -
rulebaseId: string
Read Only:
true
The rulebase unique identifier, internal to the rulebase itself.
Nested Schema : attachments
Type:
array
Read Only:
true
Contains a flat array of all the attachments in the checkpoint.
Show Source
Nested Schema : checkpointInspectDataModel
Type:
Show Source
object
-
cardinality: string
Allowed Values:
[ "OneToOne", "OneToMany", "ManyToOne", "ManyToMany" ]
If the type is 'referenceRelationship', the cardinality of the relationship. -
inferred: boolean
True if an entity or relationship is inferred, otherwise false.
-
properties: object
checkpointInspectProperties
Additional Properties Allowed:
true
-
references: string
If the type is 'referenceRelationship', the name of the target entity.
-
text: string
If the type is one of 'boolean', 'text', 'number', 'currency', 'date', 'datetime', or 'time of day', the basic text of the attribute.
-
type(required): string
Allowed Values:
[ "global", "containmentRelationship", "referenceRelationship", "boolean", "text", "number", "currency", "date", "datetime", "time of day" ]
The object type. The root object will always be of type 'global'. -
uploadGroups: array
uploadGroups
The names of the upload groups for this entity.
Nested Schema : checkpointInspectInstanceData
Type:
object
Additional Properties Allowed:
true
Nested Schema : checkpointInspectAttachment
Type:
Show Source
object
-
data: string
(byte)
The attachment as base-64 encoded binary data.Example:
QmFzZS02NCBkYXRhLg==
-
description: string
The attachment description.
-
fileName: string
The file name of the attachment.
-
groupName: string
The name of the containing group for the attachment.
-
instanceId: string
The containing entity instance id. References the @id property of the instance data model.
-
name: string
The name of the attachment.
-
signatureFlag: boolean
True if this is a signature, otherwise false.
Nested Schema : checkpointInspectProperties
Type:
object
Additional Properties Allowed:
true
Nested Schema : uploadGroups
Type:
array
The names of the upload groups for this entity.
Show Source
400 Response
The request could not be processed because it contains missing or invalid information.