Get all responses

get

/fscmRestApi/resources/11.13.18.05/supplierQualificationQuestionResponses

Request

Query Parameters
  • When this parameter is provided, the specified children are included in the resource payload (instead of just a link). The value of this query parameter is "all" or "". More than one child can be specified using comma as a separator. Example: ?expand=Employees,Localizations. Nested children can also be provided following the format "Child.NestedChild" (Example: ?expand=Employees.Managers). If a nested child is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?expand=Employees.Managers" is the same as "?expand=Employees,Employees.Managers" (which will expand Employees and Managers).
  • This parameter filters the resource fields. Only the specified fields are returned, which means that if no fields are specified, no fields are returned (useful to get only the links). If an indirect child resource is provided (Example: Employees.Managers), the missing children will be processed implicitly. For example, "?fields=Employees.Managers:Empname" is the same as "?fields=;Employees:;Employees.Managers:Empname" (which will only return the "Empname" field for Managers). the value of this query parameter is a list of resource fields. The attribute can be a direct (Example: Employees) or indirect (Example: Employees.Managers) child. It cannot be combined with expand query parameter. If both are provided, only fields will be considered.

    Format: ?fields=Attribute1,Attribute2

    Format for fields in child resource: ?fields=Accessor1:Attribute1,Attribute2
  • Used as a predefined finder to search the collection.

    Format: ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>

    The following are the available finder names and corresponding finder variables:

    • PrimaryKey: Find question responses according to the question response identifier.
      Finder Variables:
      • ResponseRepositoryId; integer; Value that uniquely identifies the question response.
  • This parameter restricts the number of resources returned inside the resource collection. If the limit exceeds the resource count then the framework will only return the available resources.
  • This parameter can be used to show only certain links while accessing a singular resource or a resource collection. The parameter value format is a comma-separated list of : <link_relation>

    Example:
    self,canonical
  • Used to define the starting position of the resource collection. If offset exceeds the resource count then no resources are returned. Default value is 0.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified fields. The parameter value is a comma-separated string of attribute names, each optionally followed by a colon and "asc" or "desc". Specify "asc" for ascending and "desc" for descending. The default value is "asc". For example, ?orderBy=field1:asc,field2:desc
  • This query parameter defines the where clause. The resource collection will be queried using the provided expressions. The value of this query parameter is one or more expressions. Example: ?q=Deptno>=10 and <= 30;Loc!=NY

    Format: ?q=expression1;expression2

    You can use these queryable attributes to filter this collection resource using the q query parameter:
    • AcceptanceDate; string; Date when the response to the question was accepted.
    • AcceptanceNote; string; Notes entered by the responder.
    • AcceptedBy; string; Name of the person who accepted the qualification response.
    • AcceptedById; integer; Value that uniquely identifies the person who accepted the qualification response.
    • DataSourceId; integer; Value that uniquely identifies the document from the source application, such as Bid Number, Questionnaire Response ID, Profile ID driving profile change, and Supplier Registration ID.
    • DataSourceType; string; Value that identifies the source of the data.
    • DataSourceTypeCode; string; Abbreviation that identifies the source application. A list of accepted values is defined in the lookup type ORA_POQ_QSTN_RESP_DATA_SOURCE. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
    • FirstSubmissionDate; string; Date and time when the response was submitted for the first time by the responder.
    • InternalResponder; string; Name of the internal responder who is responsible for responding to the questions.
    • InternalResponderId; integer; Value that uniquely identifies the internal responder who is responsible for responding to the questions.
    • OriginalQuestionId; integer; Value that uniquely identifies the original question for the revision for which this is a response.
    • ProcurementBU; string; Name of the procurement business unit where the supplier site resides.
    • Question; string; Name of the question or identifier entered by the user.
    • QuestionId; integer; Value that uniquely identifies the question.
    • QuestionRevision; integer; Number that identifies the revision of this question. Revision 0 is the base revision.
    • ResponderComments; string; Comments from the responder when submitting a response to a question on a questionnaire.
    • ResponderType; string; Value that indicates whether the response responder is a supplier or internal responder.
    • ResponderTypeCode; string; Abbreviation that identifies the whether the question responder should be a supplier, or internal responder A list of accepted values is defined in the lookup type POQ_RESPONDER_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
    • ResponseArchiveDate; string; Date and time when the response got archived because a new response was entered in the repository.
    • ResponseDate; string; Date when the response is submitted for a question.
    • ResponseRepositoryId; integer; Value that uniquely identifies the response repository.
    • ResponseStatus; string; Value that identifies the status of the response.
    • ResponseStatusCode; string; Abbreviation that identifies the response status. A list of accepted values is defined in the lookup type ORA_POQ_QUESTION_RESP_STATUS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
    • Supplier; string; Name of the supplier.
    • SupplierContact; string; Name of the supplier contact.
    • SupplierContactId; integer; Value that uniquely identifies the supplier contact.
    • SupplierId; integer; Value that uniquely identifies the supplier.
    • SupplierSite; string; Name of the supplier site.
    • SupplierSiteId; integer; Value that uniquely identifies the supplier site.
    • SurrogateEnteredBy; string; Name of the person who entered a surrogate response.
    • SurrogateEnteredById; integer; Value that uniquely identifies a person who entered a surrogate response.
    • SurrogateEntryDate; string; Date and time when the qualification manager submitted the surrogate response. The attribute value will be empty for the non-surrogate response.
    • SurrogateResponseFlag; boolean; Contains one of the following values: true or false. If true, then the response is a surrogate response entered by qualification manager on behalf of supplier or a person who is responsible for responding to the questions. If false, then the response is not a surrogate response. The default value is false.
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Header Parameters
  • 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".
  • 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.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Headers
  • 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".
  • 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.
Body ()
Root Schema : supplierQualificationQuestionResponses
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : supplierQualificationQuestionResponses-item-response
Type: object
Show Source
  • Title: Acceptance Date
    Date when the response to the question was accepted.
  • Title: Acceptance Note
    Maximum Length: 1000
    Notes entered by the responder.
  • Title: Accepted By
    Maximum Length: 240
    Name of the person who accepted the qualification response.
  • Value that uniquely identifies the person who accepted the qualification response.
  • Title: Aggregate Response
    Maximum Length: 1
    Default Value: false
    Contains one of the following values: true or false. If true, then the record is of aggregate type. If false, then the record is not of type aggregate. The default value is false.
  • Read Only: true
    Value that uniquely identifies the document from the source application, such as Bid Number, Questionnaire Response ID, Profile ID driving profile change, and Supplier Registration ID.
  • Title: Data Source Type
    Read Only: true
    Maximum Length: 80
    Value that identifies the source of the data.
  • Read Only: true
    Maximum Length: 30
    Default Value: REST_API_SERVICE
    Abbreviation that identifies the source application. A list of accepted values is defined in the lookup type ORA_POQ_QSTN_RESP_DATA_SOURCE. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Title: First Submission Date
    Read Only: true
    Date and time when the response was submitted for the first time by the responder.
  • Title: Internal Responder
    Maximum Length: 240
    Name of the internal responder who is responsible for responding to the questions.
  • Value that uniquely identifies the internal responder who is responsible for responding to the questions.
  • Links
  • Read Only: true
    Value that uniquely identifies the original question for the revision for which this is a response.
  • Title: Business Unit
    Maximum Length: 240
    Name of the procurement business unit where the supplier site resides.
  • Default Value: -9999
    Value that uniquely identifies the procurement business unit where the supplier site resides.
  • Title: Question
    Maximum Length: 80
    Name of the question or identifier entered by the user.
  • Value that uniquely identifies the question.
  • Title: Question Revision
    Read Only: true
    Number that identifies the revision of this question. Revision 0 is the base revision.
  • Title: Question Text
    Read Only: true
    Text of the question to be displayed to responders on a questionnaire.
  • Title: Responder Comments
    Maximum Length: 1000
    Comments from the responder when submitting a response to a question on a questionnaire.
  • Title: Responder Type
    Read Only: true
    Maximum Length: 80
    Value that indicates whether the response responder is a supplier or internal responder.
  • Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the whether the question responder should be a supplier, or internal responder A list of accepted values is defined in the lookup type POQ_RESPONDER_TYPE. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Title: Response Archive Date
    Read Only: true
    Date and time when the response got archived because a new response was entered in the repository.
  • Title: Response Date
    Date when the response is submitted for a question.
  • Read Only: true
    Value that uniquely identifies the response repository.
  • Title: Response Status
    Read Only: true
    Maximum Length: 80
    Value that identifies the status of the response.
  • Read Only: true
    Maximum Length: 30
    Default Value: PROCESSING
    Abbreviation that identifies the response status. A list of accepted values is defined in the lookup type ORA_POQ_QUESTION_RESP_STATUS. Review the values for this attribute using the Setup and Maintenance work area, and the Manage Standard Lookups task.
  • Title: Supplier
    Maximum Length: 360
    Name of the supplier.
  • Title: Supplier Contact
    Maximum Length: 255
    Name of the supplier contact.
  • Value that uniquely identifies the supplier contact.
  • Value that uniquely identifies the supplier.
  • Title: Supplier Site
    Maximum Length: 240
    Name of the supplier site.
  • Value that uniquely identifies the supplier site.
  • Title: Surrogate Entered By
    Read Only: true
    Maximum Length: 240
    Name of the person who entered a surrogate response.
  • Read Only: true
    Value that uniquely identifies a person who entered a surrogate response.
  • Title: Surrogate Entry Date
    Read Only: true
    Date and time when the qualification manager submitted the surrogate response. The attribute value will be empty for the non-surrogate response.
  • Title: Surrogate Response
    Read Only: true
    Maximum Length: 1
    Contains one of the following values: true or false. If true, then the response is a surrogate response entered by qualification manager on behalf of supplier or a person who is responsible for responding to the questions. If false, then the response is not a surrogate response. The default value is false.
  • Values
    Title: Values
    The Values resource manages the values for the question responses.
Nested Schema : Values
Type: array
Title: Values
The Values resource manages the values for the question responses.
Show Source
Nested Schema : supplierQualificationQuestionResponses-values-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The Attachments resource manages the attachments for the question responses.
Show Source
Nested Schema : supplierQualificationQuestionResponses-values-attachments-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get all responses.

Example cURL Command

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

curl -u username:password "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses"

Example Response Body

The following shows an example of the response body in JSON format.

{
	"items": [
	{
		"QuestionId": 300100036646653,
		"Question": "Work Ethics",
		"SupplierId": 1225,
		"Supplier": "CV_SuppA07",
		"SupplierSite": CVSuppA07Site01,
		"ResponseDate": "2018-07-19T17:37:02.788+00:00",
		"InternalResponderId": null,
		"InternalResponder": null,
		"SupplierContactId": 299931,
		"SupplierContact": "Smith, Pat",
		"QuestionRevision": 0,
		"ResponderComments": null,
		"AcceptanceNote": null,
		"ResponseRepositoryId": 52014,
		"ResponseStatusCode": "ACTIVE",
		"ResponseStatus": "Active",
		"FirstSubmissionDate": "2015-12-10T03:14:42.153+00:00",
		"ResponseArchiveDate": null,
		"AcceptanceDate": "2018-07-19T17:40:30+00:00",
		"AcceptedById": 300100037275093,
		"AcceptedBy": "POQ00020, PRC",
		"DataSourceTypeCode": "QUESTNAIRE_RESPONSE",
		"DataSourceType": "Questionnaire response",
		"DataSourceId": 300100154145922,
		"ResponderTypeCode": "SUPPLIER",
		"ResponderType": "Supplier",
		"OriginalQuestionId": 300100036646653,
		"SurrogateResponseFlag": null,
		"SurrogateEntryDate": null,
		"SurrogateEnteredById": null,
		"SurrogateEnteredBy": null,
		"ProcurementBU": "Vision Operations",
		"ProcurementBUId": 204,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/52014",
			"name": "supplierQualificationQuestionResponses",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/52014",
			"name": "supplierQualificationQuestionResponses",
			"kind": "item"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/52014/lov/InternalResponders",
			"name": "InternalResponders",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/52014/lov/AcceptedByPersons",
			"name": "AcceptedByPersons",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/52014/lov/SupplierSites",
			"name": "SupplierSites",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/52014/lov/Questions",
			"name": "Questions",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/52014/lov/SupplierContacts",
			"name": "SupplierContacts",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/52014/lov/Suppliers",
			"name": "Suppliers",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/52014/child/values",
			"name": "values",
			"kind": "collection"
		},
		{
			"rel": "enclosure",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/52014/enclosure/QuestionText",
			"name": "QuestionText",
			"kind": "other"
		}
		]
	},
	{
		"QuestionId": 300100036646653,
		"Question": "Financial Area",
		"SupplierId": 300100024124875,
		"Supplier": "PRC_POQSUPPA04",
		"SupplierSiteId": null,
		"SupplierSite": null,
		"ResponseDate": "2014-07-30T04:06:00+00:00",
		"InternalResponderId": null,
		"InternalResponder": null,
		"SupplierContactId": 300100024124924,
		"SupplierContact": "PRC_POQSUPPA04, PRC_POQSUPPA04",
		"QuestionRevision": 0,
		"ResponderComments": null,
		"AcceptanceNote": "Accepted",
		"ResponseRepositoryId": 11045,
		"ResponseStatusCode": "ACTIVE",
		"ResponseStatus": "Active",
		"FirstSubmissionDate": "2014-07-30T04:06:00+00:00",
		"ResponseArchiveDate": null,
		"AcceptanceDate": "2014-07-31T04:07:29.887+00:00",
		"AcceptedById": 100010026863791,
		"AcceptedBy": "Jones,Cody",
		"DataSourceTypeCode": "QUESTNAIRE_RESPONSE",
		"DataSourceType": "Questionnaire response",
		"DataSourceId": 300100038500092,
		"ResponderTypeCode": "SUPPLIER",
		"ResponderType": "Supplier",
		"OriginalQuestionId": 300100036646653,
		"SurrogateResponseFlag": null,
		"SurrogateEntryDate": null,
		"SurrogateEnteredById": null,
		"SurrogateEnteredBy": null,
		"ProcurementBU": null,
		"ProcurementBUId": null,
		"links": [
		{
			"rel": "self",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/11045",
			"name": "supplierQualificationQuestionResponses",
			"kind": "item",
			"properties": {
				"changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A657870000000017704000000017372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C78"
			}
		},
		{
			"rel": "canonical",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/11045",
			"name": "supplierQualificationQuestionResponses",
			"kind": "item"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/11045/lov/InternalResponders",
			"name": "InternalResponders",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/11045/lov/AcceptedByPersons",
			"name": "AcceptedByPersons",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/11045/lov/SupplierSites",
			"name": "SupplierSites",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/11045/lov/Questions",
			"name": "Questions",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/11045/lov/SupplierContacts",
			"name": "SupplierContacts",
			"kind": "collection"
		},
		{
			"rel": "lov",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/11045/lov/Suppliers",
			"name": "Suppliers",
			"kind": "collection"
		},
		{
			"rel": "child",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/11045/child/values",
			"name": "values",
			"kind": "collection"
		},
		{
			"rel": "enclosure",
			"href": "https://servername/fscmRestApi/resources/version/supplierQualificationQuestionResponses/11045/enclosure/QuestionText",
			"name": "QuestionText",
			"kind": "other"
		}
		]
	}]
}
Back to Top