Easy Form Responses API (/easy_form_responses)

Overview

Form responses are utilized in SIM and Custom Objects.

To determine if the form response is related to SIM or a custom object, check the response payload:

  • SIM-related form responses include the supplier-id field

  • Custom object form responses include the custom_object_name and custom_object_code fields

Actions

Verb

Path

Action

Description

PUT

/api/users/:user_id/easy_form_responses/:id/add_approver

add_approver

Manually add an approver for an easy form response

PUT

/api/supplier_information/:supplier_information_id/easy_form_responses/:id/add_approver

add_approver

Manually add an approver for an easy form response

PUT

/api/users/:user_id/easy_form_responses/:id/approval

approval

Submit an easy form response for approval

PUT

/api/supplier_information/:supplier_information_id/easy_form_responses/:id/approval

approval

Submit an easy form response for approval

GET

/api/users/:user_id/easy_form_responses

index

Query easy form responses

GET

/api/supplier_information/:supplier_information_id/easy_form_responses

index

Query easy form responses

PUT

/api/users/:user_id/easy_form_responses/:id/remove_approval

remove_approval

Remove an apporver who was manually added

PUT

/api/supplier_information/:supplier_information_id/easy_form_responses/:id/remove_approval

remove_approval

Remove an apporver who was manually added

PUT

/api/users/:user_id/easy_form_responses/:id/review

review

Review an easy form response

PUT

/api/supplier_information/:supplier_information_id/easy_form_responses/:id/review

review

Review an easy form response

GET

/api/users/:user_id/easy_form_responses/:id

show

Show an easy form response

GET

/api/supplier_information/:supplier_information_id/easy_form_responses/:id

show

Show an easy form response

PUT

/api/users/:user_id/easy_form_responses/:id

update

Update easy form response

PUT

/api/supplier_information/:supplier_information_id/easy_form_responses/:id

update

Update easy form response

Note:

StateIsoCode is available for SIM Easy Form Responses. The region element returns the following: {country: country, state: state, state_iso_code: ISO-3166-2 codes}. If the country does not have state options, the API returns the following: {country: Antarctica, state: NA, state_iso_code: nil}.

Elements

Element

Description

Req'd

Unique

Allowable Value

In

Out

Data Type

approvals

Approvals

yes

Approval

created-at

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

yes

datetime

created-by

User who created

yes

User

current-approval

Current approval details

yes

current-parallel-approvals

Current parallel approvals

yes

Approval

easy-form-id

Easy form ID associated with this easy form response

yes

yes

integer

easy-form-widget-responses

The widget responses

yes

Easy Form Widget Response

id

Object unique identifier (must exist)

yes

integer

name

Name of the easy form response

yes

string(255)

requested-by

User that requested

yes

User

status

Status of the easy form response

yes

string(255)

subject

Object associated with this easy form response

yes

Invoice Header Invoice Line Supplier Information User

submitted-at

The date/time the response was submitted in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

yes

datetime

updated-at

Automatically created by Coupa in the format YYYY-MM-DDTHH:MM:SS+HH:MMZ

yes

datetime

updated-by

User who updated

yes

User

preferred

Preferred

yes

string(255)