Jump to

• Request
• Response

Set a checkpoint data.

post

/fscmRestApi/resources/11.13.18.05/publicSectorOpaCheckPointData

Set new checkpoint data or update existing checkpoint data corresponding to the given checkpoint identifier

Request

Supported Media Types

• application/vnd.oracle.adf.action+json

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorOpaCheckPointData-setCheckPointDataRequest

Type: object

Show Source

• name(optional): string
  Allowed Values: [ "setCheckPointData" ]

  This parameter value must be set to "setCheckPointData".
• parameters(optional): array parameters
  Minimum Number of Items: 6

  Maximum Number of Items: 6

{
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "setCheckPointData"
            ],
            "description":"This parameter value must be set to \"setCheckPointData\"."
        },
        "parameters":{
            "items":[
                {
                    "properties":{
                        "checkPointID":{
                            "type":"string",
                            "description":"The unique identifier of the checkpoint."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                },
                {
                    "properties":{
                        "providerID":{
                            "type":"string",
                            "description":"The unique identifier of the provider associated with the checkpoint data."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                },
                {
                    "properties":{
                        "interviewName":{
                            "type":"string",
                            "description":"The name of the interview that is associated with the checkpoint data."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                },
                {
                    "properties":{
                        "interviewVersion":{
                            "type":"string",
                            "description":"The version of the interview that is associated with the checkpoint data."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                },
                {
                    "properties":{
                        "extraParameters":{
                            "type":"string",
                            "description":"The extra information associated with the checkpoint data."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                },
                {
                    "properties":{
                        "checkPointData":{
                            "type":"string",
                            "description":"The checkpoint data."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                }
            ],
            "minItems":6,
            "maxItems":6,
            "type":"array"
        }
    },
    "type":"object"
}

Nested Schema : parameters

Type: array

Minimum Number of Items: 6

Maximum Number of Items: 6

Show Source

• [0]: object parameters-items[0]
• [1]: object parameters-items[1]
• [2]: object parameters-items[2]
• [3]: object parameters-items[3]
• [4]: object parameters-items[4]
• [5]: object parameters-items[5]

{
    "items":[
        {
            "properties":{
                "checkPointID":{
                    "type":"string",
                    "description":"The unique identifier of the checkpoint."
                }
            },
            "additionalProperties":false,
            "type":"object"
        },
        {
            "properties":{
                "providerID":{
                    "type":"string",
                    "description":"The unique identifier of the provider associated with the checkpoint data."
                }
            },
            "additionalProperties":false,
            "type":"object"
        },
        {
            "properties":{
                "interviewName":{
                    "type":"string",
                    "description":"The name of the interview that is associated with the checkpoint data."
                }
            },
            "additionalProperties":false,
            "type":"object"
        },
        {
            "properties":{
                "interviewVersion":{
                    "type":"string",
                    "description":"The version of the interview that is associated with the checkpoint data."
                }
            },
            "additionalProperties":false,
            "type":"object"
        },
        {
            "properties":{
                "extraParameters":{
                    "type":"string",
                    "description":"The extra information associated with the checkpoint data."
                }
            },
            "additionalProperties":false,
            "type":"object"
        },
        {
            "properties":{
                "checkPointData":{
                    "type":"string",
                    "description":"The checkpoint data."
                }
            },
            "additionalProperties":false,
            "type":"object"
        }
    ],
    "minItems":6,
    "maxItems":6,
    "type":"array"
}

Nested Schema : parameters-items[0]

Type: object

Show Source

• checkPointID(optional): string
  The unique identifier of the checkpoint.

{
    "properties":{
        "checkPointID":{
            "type":"string",
            "description":"The unique identifier of the checkpoint."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Nested Schema : parameters-items[1]

Type: object

Show Source

• providerID(optional): string
  The unique identifier of the provider associated with the checkpoint data.

{
    "properties":{
        "providerID":{
            "type":"string",
            "description":"The unique identifier of the provider associated with the checkpoint data."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Nested Schema : parameters-items[2]

Type: object

Show Source

• interviewName(optional): string
  The name of the interview that is associated with the checkpoint data.

{
    "properties":{
        "interviewName":{
            "type":"string",
            "description":"The name of the interview that is associated with the checkpoint data."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Nested Schema : parameters-items[3]

Type: object

Show Source

• interviewVersion(optional): string
  The version of the interview that is associated with the checkpoint data.

{
    "properties":{
        "interviewVersion":{
            "type":"string",
            "description":"The version of the interview that is associated with the checkpoint data."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Nested Schema : parameters-items[4]

Type: object

Show Source

• extraParameters(optional): string
  The extra information associated with the checkpoint data.

{
    "properties":{
        "extraParameters":{
            "type":"string",
            "description":"The extra information associated with the checkpoint data."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Nested Schema : parameters-items[5]

Type: object

Show Source

• checkPointData(optional): string
  The checkpoint data.

{
    "properties":{
        "checkPointData":{
            "type":"string",
            "description":"The checkpoint data."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.actionresult+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorOpaCheckPointData-setCheckPointDataResponse

Type: object

Show Source

• return(optional): string
  The checkpoint identifier associated with the checkpoint data.

{
    "properties":{
        "return":{
            "type":"string",
            "description":"The checkpoint identifier associated with the checkpoint data."
        }
    },
    "type":"object"
}

Back to Top