Get one requisition processing request header
get
/fscmRestApi/resources/11.13.18.05/requisitionProcessingRequests/{requisitionProcessingRequestsUniqID}
Request
Path Parameters
-
requisitionProcessingRequestsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Requisition Processing Requests resource and used to uniquely identify an instance of Requisition Processing Requests. The client should not generate the hash key value. Instead, the client should query on the Requisition Processing Requests collection resource in order to navigate to a specific instance of Requisition Processing Requests to get the hash key.
Query Parameters
-
dependency: string
This parameter specifies dependencies which are fields that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The fields specified in this parameter are always set in the resource instance in question. When a child resource collection is requested and the parameter is set, the fields will be set in the parent resource instance before generating the resource collection payload. The value of this query parameter is a set of dependency fields. Example: dependency=ProductId=2
Format: <attr1>=<val1>,<attr2>=<value2> -
expand: string
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).
-
fields: string
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 -
links: string
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 -
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
Header Parameters
-
Effective-Of:
This header accepts a string value. The string is a semi-colon separated list of
= . It is used to perform effective date range operations. The accepted parameters are RangeMode, RangeSpan, RangeStartDate, RangeEndDate, RangeStartSequence and RangeEndSequence. The parameter values are always strings. The possible values for RangeMode are SET_LOGICAL_START, SET_LOGICAL_END, END_DATE, SET_EFFECTIVE_START, SET_EFFECTIVE_END, REPLACE_CORRECTION, REPLACE_UPDATE, RECONCILE_CORRECTION, CORRECTION, RECONCILE_UPDATE, UPDATE, ZAP and DELETE_CHANGES. The possible values for RangeSpan are PHYSICAL_ROW_END_DATE and LOGICAL_ROW_END_DATE. The values for RangeStartDate and RangeEndDate have to be a string representation of a date in yyyy-MM-dd format. The value for RangeStartSequence and RangeEndSequence must be strings such that when parsed they yield positive integers. -
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.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
Default Response
The following table describes the default response for this task.
Headers
-
Metadata-Context(required):
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(required):
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.
Root Schema : requisitionProcessingRequests-item-response
Type:
Show Source
object
-
Buyer: string
Title:
Buyer
Maximum Length:240
Person who is responsible for managing the procurement document. -
BuyerId: integer
(int64)
Value that uniquely identifies the buyer.
-
ConversionRate: number
Rate to use when converting currency.
-
ConversionRateDate: string
(date)
Date to use for the conversion rate when converting an ordered amount into another currency. The conversion rate varies depending on the date.
-
ConversionRateType: string
Title:
Conversion Rate Type
Maximum Length:30
Type of rate that the application uses to determine the currency conversion rate for the purchase order. -
ConversionRateTypeCode: string
Maximum Length:
30
Abbreviation that identifies the type of rate that the application uses to determine the currency conversion rate for the purchase order. -
Currency: string
Title:
Currency
Maximum Length:80
Abbreviation that identifies the currency of the purchase order. -
CurrencyCode: string
Maximum Length:
15
Abbreviation that identifies the currency code of the purchase order. -
DocumentStyle: string
Title:
Document Style
Maximum Length:240
Name of the purchasing document style. This attribute allows organizations to control the parameters and values displayed on the application to match the usage of the purchasing document. -
DocumentStyleId: integer
(int64)
Value that uniquely identifies the purchasing style of the document.
-
GroupRequisitionLines: string
Contains one of the following values: Y or N. If Y, then requisition lines are combined on order lines in the purchase order. If N, then you can't group requisition lines.
-
lines: array
Lines
Title:
Lines
The Lines resource manages the requisition lines that need to be processed into a procurement document. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OrderNumber: string
Maximum Length:
30
Number that uniquely identifies the purchase order. -
POHeaderId: integer
(int64)
Value that uniquely identifies the purchase order header.
-
ProcurementBU: string
Title:
Procurement BU
Maximum Length:240
Business unit that manages and owns the requisition and corresponding purchase order or a negotiation. -
ProcurementBUId: integer
(int64)
Value that uniquely identifies the business unit that manages and owns the requisition and corresponding purchase order or a negotiation.
-
RequestHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the request header. -
RequisitioningBU: string
Title:
Requisitioning BU
Maximum Length:240
Name of the business unit that raised the requisition for goods and services. -
RequisitioningBUId: integer
(int64)
Value that uniquely identifies the business unit that raised the requisition for goods and services.
-
SoldToLegalEntity: string
Title:
Sold-to Legal Entity
Legal entity that is financially responsible for purchases on the purchase order. -
SoldToLegalEntityId: integer
(int64)
Value that uniquely identifies the legal entity that is financially responsible for purchases on the purchase order.
-
SourceAgreement: string
Title:
Source Agreement
Maximum Length:30
Number that uniquely identifies the source agreement. -
SourceAgreementId: integer
(int64)
Value that uniquely identifies the source agreement.
-
Supplier: string
Title:
Supplier
Maximum Length:360
Name of the supplier. -
SupplierId: integer
(int64)
Value that uniquely identifies the supplier.
-
SupplierSite: string
Title:
Supplier Site
Maximum Length:240
Location that the supplier uses to purchase the item. -
SupplierSiteId: integer
(int64)
Value that uniquely identifies the supplier site.
-
Type: string
Title:
Type
Values that uniquely identify the document type. Type can be a new order or an existing order or a negotiation.
Nested Schema : Lines
Type:
array
Title:
Lines
The Lines resource manages the requisition lines that need to be processed into a procurement document.
Show Source
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : requisitionProcessingRequests-lines-item-response
Type:
Show Source
object
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RequestHeaderId: integer
(int64)
Read Only:
true
Value that uniquely identifies the request header. -
RequestLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the request line. -
RequisitionLineId: integer
(int64)
Value that uniquely identifies the requisition line.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : link
Type:
Show Source
object
-
href: string
Title:
hyperlink reference
The URI to the related resource. -
kind: string
Title:
kind
Allowed Values:[ "collection", "item", "describe", "other" ]
The kind of the related resource. -
name: string
Title:
name
The name of the link to the related resource. -
properties: object
properties
-
rel: string
Title:
relation
Allowed Values:[ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]
The name of the relation to the resource instance. Example: self.
Nested Schema : properties
Type:
Show Source
object
-
changeIndicator: string
Change indicator or the ETag value of the resource instance.
Links
- lines
-
Parameters:
- requisitionProcessingRequestsUniqID:
$request.path.requisitionProcessingRequestsUniqID
The Lines resource manages the requisition lines that need to be processed into a procurement document. - requisitionProcessingRequestsUniqID:
- processRequest
-
Parameters:
- requisitionProcessingRequestsUniqID:
$request.path.requisitionProcessingRequestsUniqID
Validates the requisition processing request and either creates a draft purchase order or an incomplete change order. - requisitionProcessingRequestsUniqID:
Examples
The following example describes how to get a requisition processing request header.
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/requisitionProcessingRequests/requestheaderid
Example Response Body
The following example includes the contents of the response body in JSON format:
{ "RequestHeaderId": 300100542087017, "ProcurementBUId": 204, "ProcurementBU": "Vision Corporation", "RequisitioningBUId": 204, "RequisitioningBU": "Vision Corporation", "Type": "New Order", "SoldToLegalEntityId": null, "SoldToLegalEntity": null, "SupplierId": null, "Supplier": null, "SupplierSiteId": null, "SupplierSite": null, "DocumentStyleId": 300100095828198, "DocumentStyle": "PONESCDST01_Purchase Order", "SourceAgreementId": null, "SourceAgreement": null, "CurrencyCode": null, "Currency": null, "ConversionRateTypeCode": null, "ConversionRateType": null, "ConversionRateDate": null, "ConversionRate": null, "BuyerId": null, "Buyer": null, "GroupRequisitionLines": null, "links": [ { "rel": "self", "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542087017", "name": "requisitionProcessingRequests", "kind": "item", "properties": { "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000001770400000001737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B02000078700000000178" } }, { "rel": "canonical", "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542087017", "name": "requisitionProcessingRequests", "kind": "item" }, { "rel": "child", "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542087017/child/lines", "name": "lines", "kind": "collection" }, { "rel": "action", "href": "https://servername/fscmRestApi/resources/version/requisitionProcessingRequests/300100542087017/action/processRequest", "name": "processRequest", "kind": "other" } ] }