Jump to

• Request
• Response

Inspect a checkpoint

post

https://{your_site_interface}/opa-hub/api/12.2.39/checkpointInspect

This operation will inspect a given checkpoint.

Request

There are no request parameters for this operation.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• checkpoint(required): string (byte)
  Example: QmFzZS02NCBkYXRhLg==

{
    "type":"object",
    "properties":{
        "checkpoint":{
            "type":"string",
            "format":"byte",
            "writeOnly":true,
            "example":"QmFzZS02NCBkYXRhLg=="
        }
    },
    "additionalProperties":false,
    "required":[
        "checkpoint"
    ]
}

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.

Back to Top

Response

Supported Media Types

• application/json

200 Response

The checkpoint was successfully inspected.

Body ()

Root Schema : checkpointInspect

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "rulebaseId":{
            "type":"string",
            "description":"The rulebase unique identifier, internal to the rulebase itself.",
            "readOnly":true
        },
        "productVersion":{
            "type":"string",
            "description":"The product version in which this checkpoint was created.",
            "readOnly":true
        },
        "dataModel":{
            "description":"The data model, inferred from the checkpoint data.",
            "readOnly":true,
            "$ref":"#/components/schemas/checkpointInspectDataModel"
        },
        "instanceData":{
            "description":"The checkpoint instance data, described by the data model. Each entity instance is identified by the @id property. All other property names will be specified by an item in the data model.",
            "readOnly":true,
            "$ref":"#/components/schemas/checkpointInspectInstanceData"
        },
        "attachments":{
            "type":"array",
            "description":"Contains a flat array of all the attachments in the checkpoint.",
            "readOnly":true,
            "items":{
                "description":"An attachment within a checkpoint.",
                "$ref":"#/components/schemas/checkpointInspectAttachment"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : attachments

Type: array

Read Only: true

Contains a flat array of all the attachments in the checkpoint.

Show Source

• Array of: object checkpointInspectAttachment

{
    "type":"array",
    "description":"Contains a flat array of all the attachments in the checkpoint.",
    "readOnly":true,
    "items":{
        "description":"An attachment within a checkpoint.",
        "$ref":"#/components/schemas/checkpointInspectAttachment"
    }
}

Nested Schema : checkpointInspectDataModel

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "type":{
            "type":"string",
            "description":"The object type. The root object will always be of type 'global'.",
            "enum":[
                "global",
                "containmentRelationship",
                "referenceRelationship",
                "boolean",
                "text",
                "number",
                "currency",
                "date",
                "datetime",
                "time of day"
            ]
        },
        "inferred":{
            "type":"boolean",
            "description":"True if an entity or relationship is inferred, otherwise false."
        },
        "uploadGroups":{
            "type":"array",
            "description":"The names of the upload groups for this entity.",
            "items":{
                "type":"string"
            }
        },
        "properties":{
            "description":"If the type is 'global' or 'containmentRelationship', the attributes, entities, and relationships contained by this entity.",
            "$ref":"#/components/schemas/checkpointInspectProperties"
        },
        "references":{
            "type":"string",
            "description":"If the type is 'referenceRelationship', the name of the target entity."
        },
        "cardinality":{
            "type":"string",
            "description":"If the type is 'referenceRelationship', the cardinality of the relationship.",
            "enum":[
                "OneToOne",
                "OneToMany",
                "ManyToOne",
                "ManyToMany"
            ]
        },
        "text":{
            "type":"string",
            "description":"If the type is one of 'boolean', 'text', 'number', 'currency', 'date', 'datetime', or 'time of day', the basic text of the attribute."
        }
    },
    "additionalProperties":false,
    "required":[
        "type"
    ]
}

Nested Schema : checkpointInspectInstanceData

Type: object

Additional Properties Allowed: true

Nested Schema : checkpointInspectAttachment

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"The name of the attachment."
        },
        "groupName":{
            "type":"string",
            "description":"The name of the containing group for the attachment."
        },
        "fileName":{
            "type":"string",
            "description":"The file name of the attachment."
        },
        "description":{
            "type":"string",
            "description":"The attachment description."
        },
        "signatureFlag":{
            "type":"boolean",
            "description":"True if this is a signature, otherwise false."
        },
        "instanceId":{
            "type":"string",
            "description":"The containing entity instance id. References the @id property of the instance data model."
        },
        "data":{
            "type":"string",
            "format":"byte",
            "description":"The attachment as base-64 encoded binary data.",
            "example":"QmFzZS02NCBkYXRhLg=="
        }
    },
    "additionalProperties":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

• Array of: string

{
    "type":"array",
    "description":"The names of the upload groups for this entity.",
    "items":{
        "type":"string"
    }
}

400 Response

The request could not be processed because it contains missing or invalid information.

Back to Top