GET one action not supported
get
/fscmRestApi/resources/11.13.18.05/purchaseRequisitions/{purchaseRequisitionsUniqID}/child/summaryAttributes/{RequisitionHeaderId}
Request
Path Parameters
-
RequisitionHeaderId(required): integer(int64)
The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
-
purchaseRequisitionsUniqID(required): string
This is the hash key of the attributes which make up the composite key for the Purchase Requisitions resource and used to uniquely identify an instance of Purchase Requisitions. The client should not generate the hash key value. Instead, the client should query on the Purchase Requisitions collection resource in order to navigate to a specific instance of Purchase Requisitions 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
-
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 : purchaseRequisitions-summaryAttributes-item-response
Type:
Show Source
object
-
AccountUserOverrideFlag: boolean
Maximum Length:
1
Contains one of the following values: Y, or N, or Null. If Y, the charge account is updated by the user on all the requisition lines. If N, the charge account isn't updated by the user on all the requisition lines. If Null, the charge account is updated by the user on some of the requisition lines. -
ActiveLineCount: number
Number of requisition lines excluding split and replaced lines for the requisition.
-
Buyer: string
Maximum Length:
255
Name of the buyer responsible for managing the requisition line or purchase order associated with the line through its life cycle. -
BuyerCount: number
Number of buyers from the orders that were opened or assigned to the lines for the requisition.
-
BuyerId: integer
Value that uniquely identifies the buyer responsible for managing the requisition line or purchase order associated with the line through its life cycle.
-
CategoryId: integer
Value that uniquely identifies the purchasing category across all the requisition lines. The value is set to Null if the purchasing category is different across the requisition lines.
-
ChargeAccount: string
Title:
Charge Account
Maximum Length:255
Account that the purchase from a requisition is charged to. -
ChargeAccountId: integer
Value that uniquely identifies the account that the purchase from a requisition is charged to.
-
ChargeToSingleAccountFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, all the requisition lines are charged to the same charge account. If false, then the charge account is different on lines. The default value is false. -
ContainsNoneditableLinesFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the requisition contains lines that can't be edited. If false, then it doesn't contain noneditable lines. The default value is false. -
DeliverToLocationCode: string
Title:
Deliver-to Location
Maximum Length:255
Abbreviation that identifies the final location where the buying company should deliver the goods that were previously received from a supplier. -
DeliverToLocationId: integer
Value that uniquely identifies the final location where the buying company should deliver the goods that were previously received from a supplier.
-
DeliverToOneTimeLocationAddress: string
Title:
One-Time Location Address
Maximum Length:255
Physical address of the one time location where the buying company should deliver the goods previously received from a supplier. -
DeliverToOneTimeLocationId: integer
Value that uniquely identifies the one time location where the buying company should deliver the goods that were previously received from a supplier.
-
DeliverToSingleLocationFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, all the requisition lines have the same delivery location. If false, then the delivery location is different on lines. The default value is false. -
DestinationTypeCode: string
Maximum Length:
255
Value that uniquely identifies the destination type code on the requisition lines. The value is set to Null if the destination type code is different across the requisition lines. -
HasAllMasterItemsFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then all the requisition lines are for master items. This attribute doesn't have a default value. -
HasOneTimeLocAcrossLinesFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then at least one of the requisition lines has a one-time deliver-to location type. This attribute doesn't have a default value. -
LineCount: number
Number of lines in the requisition.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
OneTimeLocationCountAcrossRequisition: integer
Total count of the one-time locations available across requisition. This count doesn't include one-time location for the current requisition.
-
OneTimeLocationCountAcrossRequisitionLine: integer
Total count of the one-time locations available across requisition lines. This count doesn't include one-time location for the current requisition line.
-
POHeaderId: integer
Value that uniquely identifies first purchase order that was opened for the requisition.
-
ProjectCostingDetailsCode: string
Maximum Length:
25
Contains one of the following values: NONE, SINGLE, or MULTIPLE. If none of the distributions have project costing details associated with them, the attribute value is set to NONE. If all the distributions have exactly the same project and task associated with them, it is set to SINGLE. If the project and task associated with the distributions are different, it is set to MULTIPLE. -
ProjectId: number
Value that uniquely identifies the project.
-
ProjectName: string
Maximum Length:
240
Name of the project, which is displayed on the requisition header. -
ProjectNumber: string
Maximum Length:
25
Number of the project, which is displayed on the requisition header. -
ProjectsInformationAcrossLines: string
Maximum Length:
25
Contains one of the following values: NONE, SINGLE, or MULTIPLE. If none of the distributions have project costing details associated with them, the attribute value is set to NONE. If all the distributions have the same project associated with them and the costing details are exactly the same, it is set to SINGLE. If the project costing details of the distributions are different, it is set to MULTIPLE. -
PurchaseOrder: string
Maximum Length:
255
Number that identifies the first purchase order that was opened for the requisition. -
PurchaseOrderCount: number
Number of purchase orders that were opened for the requisition.
-
RequestedDeliveryDate: string
(date)
Title:
Requested Delivery Date
Date when the buying company requested the ordered item or service to be delivered. -
Requester: string
Maximum Length:
240
Display name of the person for whom goods or services are being ordered. The value is set to Null if the requester is different across requisition lines. -
RequesterId: integer
Value that uniquely identifies the person for whom goods or services are being ordered. The value is set to Null if the requester is different across the requisition lines.
-
RequisitionApprovalAmount: number
Title:
Approval Amount
Sum total of RequisitionTotalAmount and RequisitionNonRecoverableTaxAmount expressed in the functional currency. -
RequisitionHeaderId: integer
Value that uniquely identifies the requisition.
-
RequisitionNonRecoverableTaxAmount: number
Title:
Nonrecoverable Tax
Sum total of nonrecoverable tax amounts across all requisition lines expressed in the functional currency. -
RequisitionTotalAmount: number
Title:
Requisition Amount
Sum total of distribution amounts across all requisition lines expressed in the functional currency. -
SameAccountUserOverrideFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, all the requisition lines have the charge account either updated or not updated by the user. If false, the charge account is updated on some of the requisition lines by the user. This attribute doesn't have a default value. -
SameCategoryIdFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, all the requisition lines have the same purchasing category. If false, the purchasing category is different across the requisition lines. This attribute doesn't have a default value. -
SameDestinationOrganizationIdFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then all the lines in the requisition contain the same destination organization ID. -
SameDestinationSubinventoryFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then all the requisition lines have the same destination subinventory attribute. This attribute doesn't have a default value. -
SameDestinationTypeCodeFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, all the requisition lines have the same destination type. If false, the destination type is different on the requisition lines. This attribute doesn't have a default value. -
SameRequestedDeliveryDateFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, all the requisition lines carry the same requested delivery date value. If false, then the requested delivery date is different on lines. The default value is false. -
SameRequesterIdFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, all the requisition lines are ordered for the same person. If false, the requisition lines are ordered for different persons. This attribute doesn't have a default value. -
TaskName: string
Maximum Length:
240
Name of the project task, which is displayed on the requisition header. -
TaskNumber: string
Maximum Length:
240
Number of the project task, which is displayed on the requisition header. -
TOHeaderId: integer
Value that uniquely identifies the first transfer order that was opened for the requisition.
-
TotalIMTLinesCount: number
Number of internal material transfer lines in a requisition.
-
TransferOrder: string
Maximum Length:
255
Number that identifies the first transfer order that was opened for the requisition. -
TransferOrderCount: number
Number of transfer orders that were opened for the requisition.
-
UnprocessedIMTLinesCount: number
Number of internal material transfer lines in a requisition for which the transfer price hasn't been derived.
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.