Jump to

• Request
• Response

Save the outcome data at the end of an interview.

post

/fscmRestApi/resources/11.13.18.05/publicSectorOpaMetaDataModels

Save the outcome data for a given metadata model name at the end of an Oracle Policy Automation interview.

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 : publicSectorOpaMetaDataModels-getOPASaveDataRequest

Type: object

Show Source

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

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

  Maximum Number of Items: 6

{
    "properties":{
        "name":{
            "type":"string",
            "enum":[
                "getOPASaveData"
            ],
            "description":"This parameter value must be set to \"getOPASaveData\"."
        },
        "parameters":{
            "items":[
                {
                    "properties":{
                        "metaDataModelName":{
                            "type":"string",
                            "description":"The name of the metadata model to be used for saving the outcome of an interview."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                },
                {
                    "properties":{
                        "language":{
                            "type":"string",
                            "description":"The language information to be used for an interview."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                },
                {
                    "properties":{
                        "region":{
                            "type":"string",
                            "description":"The region information to be used for an interview."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                },
                {
                    "properties":{
                        "timeZone":{
                            "type":"string",
                            "description":"The time zone information to be used for an interview."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                },
                {
                    "properties":{
                        "parameters":{
                            "type":"string",
                            "description":"The extra information to be used for an interview."
                        }
                    },
                    "additionalProperties":false,
                    "type":"object"
                },
                {
                    "properties":{
                        "saveData":{
                            "type":"string",
                            "description":"The outcome data to be saved at the end of an interview."
                        }
                    },
                    "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":{
                "metaDataModelName":{
                    "type":"string",
                    "description":"The name of the metadata model to be used for saving the outcome of an interview."
                }
            },
            "additionalProperties":false,
            "type":"object"
        },
        {
            "properties":{
                "language":{
                    "type":"string",
                    "description":"The language information to be used for an interview."
                }
            },
            "additionalProperties":false,
            "type":"object"
        },
        {
            "properties":{
                "region":{
                    "type":"string",
                    "description":"The region information to be used for an interview."
                }
            },
            "additionalProperties":false,
            "type":"object"
        },
        {
            "properties":{
                "timeZone":{
                    "type":"string",
                    "description":"The time zone information to be used for an interview."
                }
            },
            "additionalProperties":false,
            "type":"object"
        },
        {
            "properties":{
                "parameters":{
                    "type":"string",
                    "description":"The extra information to be used for an interview."
                }
            },
            "additionalProperties":false,
            "type":"object"
        },
        {
            "properties":{
                "saveData":{
                    "type":"string",
                    "description":"The outcome data to be saved at the end of an interview."
                }
            },
            "additionalProperties":false,
            "type":"object"
        }
    ],
    "minItems":6,
    "maxItems":6,
    "type":"array"
}

Nested Schema : parameters-items[0]

Type: object

Show Source

• metaDataModelName(optional): string
  The name of the metadata model to be used for saving the outcome of an interview.

{
    "properties":{
        "metaDataModelName":{
            "type":"string",
            "description":"The name of the metadata model to be used for saving the outcome of an interview."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Nested Schema : parameters-items[1]

Type: object

Show Source

• language(optional): string
  The language information to be used for an interview.

{
    "properties":{
        "language":{
            "type":"string",
            "description":"The language information to be used for an interview."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Nested Schema : parameters-items[2]

Type: object

Show Source

• region(optional): string
  The region information to be used for an interview.

{
    "properties":{
        "region":{
            "type":"string",
            "description":"The region information to be used for an interview."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Nested Schema : parameters-items[3]

Type: object

Show Source

• timeZone(optional): string
  The time zone information to be used for an interview.

{
    "properties":{
        "timeZone":{
            "type":"string",
            "description":"The time zone information to be used for an interview."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Nested Schema : parameters-items[4]

Type: object

Show Source

• parameters(optional): string
  The extra information to be used for an interview.

{
    "properties":{
        "parameters":{
            "type":"string",
            "description":"The extra information to be used for an interview."
        }
    },
    "additionalProperties":false,
    "type":"object"
}

Nested Schema : parameters-items[5]

Type: object

Show Source

• saveData(optional): string
  The outcome data to be saved at the end of an interview.

{
    "properties":{
        "saveData":{
            "type":"string",
            "description":"The outcome data to be saved at the end of an interview."
        }
    },
    "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 : publicSectorOpaMetaDataModels-getOPASaveDataResponse

Type: object

Show Source

• return(optional): string
  The acknowledgement on saving the outcome data at the end of an interview.

{
    "properties":{
        "return":{
            "type":"string",
            "description":"The acknowledgement on saving the outcome data at the end of an interview."
        }
    },
    "type":"object"
}

Back to Top