Jump to

• Request
• Response
• Examples

Populate responses

post

/fscmRestApi/resources/11.13.18.05/questionnaireResponses/action/populateResponses

Populate responses for questionnaires and checklists

Request

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

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

Request Body - application/vnd.oracle.adf.action+json ()

Root Schema : schema

Type: object

Show Source

• parameters: object parameters
  Additional Properties Allowed: additionalProperties

  Manage the key value pair for the user-specified action parameters.

{
    "type":"object",
    "properties":{
        "parameters":{
            "type":"object",
            "additionalProperties":{
                "type":"string"
            },
            "description":"Manage the key value pair for the user-specified action parameters.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : parameters

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    },
    "description":"Manage the key value pair for the user-specified action parameters.",
    "nullable":true
}

Manage the key value pair for the user-specified action parameters.

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): string
  If the user-specified action is successful, then it's response is successfully validated or submitted.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"string",
            "description":"If the user-specified action is successful, then it's response is successfully validated or submitted."
        }
    },
    "additionalProperties":false
}

Back to Top

Examples

These examples describe how to populate responses for questionnaires and checklists.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/questionnaireResponses/action/populateResponses"

For example:

curl -u username:password -X POST -H "Content-Type:application/vnd.oracle.adf.resourceitem+json" -d 'request payload' 
"https://servername/fscmRestApi/resources/version/"

Generate Questionnaires

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{ "parameters": {
       "QuestionnaireRespHeaderId": 300100584908955,
        "ResponseIntent": "Generate"
    }}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "result": "Success"
}

Default Prerequisite Responses

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{ "parameters": {
       "QuestionnaireRespHeaderId": 300100584908955,
        "ResponseIntent": "Default"
    }}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "result": "Success"
}

Validate Checklist

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{ "parameters": {
       "QuestionnaireRespHeaderId": 300100584908955,
        "ResponseIntent": "Validate"
    }}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "result": "Success"
}

Submit a Checklist

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{ "parameters": {
       "QuestionnaireRespHeaderId": 300100584908955,
        "ResponseIntent": "Submit"
    }}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "result": "Success"
}

Back to Top