Get lifecycle details for one requisition

get

/fscmRestApi/resources/11.13.18.05/requisitionLifecycleDetails/{RequisitionHeaderId}

Request

Path Parameters
  • 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=
Query Parameters
  • 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>
  • 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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
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 : requisitionLifecycleDetails-item-response
Type: object
Show Source
Nested Schema : Invoices
Type: array
Title: Invoices
The invoices details, if any, that are associated with lines in the purchase order.
Show Source
Nested Schema : Negotiations
Type: array
Title: Negotiations
The Negotiations resource retrieves the details of the negotiations, if any, that are associated with lines in the requisition.
Show Source
Nested Schema : Summary Attributes for Orders
Type: array
Title: Summary Attributes for Orders
The Summary Attributes for Orders resource retrieves the aggregated summary details of all purchase orders associated with a requisition. The summary details include the ordered, in transit, in receiving, delivered, and invoiced amounts that help you track the fulfillment of your request.
Show Source
Nested Schema : Purchase Order History Details
Type: array
Title: Purchase Order History Details
Detailed history of all actions such as submit purchase order or submit purchase order change taken on a purchase order.
Show Source
Nested Schema : Receipts
Type: array
Title: Receipts
The receipts details, if any, that are associated with purchase order schedules.
Show Source
Nested Schema : Requisition History Details
Type: array
Title: Requisition History Details
The detailed history of all actions such as submit or cancel taken on a requisition.
Show Source
Nested Schema : Requisition Lines
Type: array
Title: Requisition Lines
The Requisition Lines resource retrieves the approved requisition lines that are sourced externally along with the details of the purchase order schedules associated with the requisition lines. This resource helps you track the quantity ordered, shipped, received, delivered, and invoiced for each purchase order schedule.
Show Source
Nested Schema : Shipments
Type: array
Title: Shipments
The Shipments resource retrieves the details of the shipments, if any, that are associated with purchase order schedules.
Show Source
Nested Schema : Transfer Order History Details
Type: array
Title: Transfer Order History Details
The detailed history of all actions taken on a transfer order such as create or cancel.
Show Source
Nested Schema : requisitionLifecycleDetails-invoices-item-response
Type: object
Show Source
Nested Schema : requisitionLifecycleDetails-negotiations-item-response
Type: object
Show Source
Nested Schema : requisitionLifecycleDetails-orderSummaryAttributes-item-response
Type: object
Show Source
Nested Schema : Related Documents of a Purchase Order
Type: array
Title: Related Documents of a Purchase Order
The Related Documents resource retrieves the count of all unprocessed lines, negotiations, and documents such as shipments, receipts, invoices, if any, for a purchase order.
Show Source
Nested Schema : requisitionLifecycleDetails-orderSummaryAttributes-relatedDocuments-item-response
Type: object
Show Source
Nested Schema : requisitionLifecycleDetails-purchaseOrderHistoryDetails-item-response
Type: object
Show Source
Nested Schema : Purchase Order Approval History Details
Type: array
Title: Purchase Order Approval History Details
The detailed history of all actions such as approve or reject taken on a purchase order.
Show Source
Nested Schema : requisitionLifecycleDetails-purchaseOrderHistoryDetails-purchaseOrderApprovalHistoryDetails-item-response
Type: object
Show Source
Nested Schema : Approval Task Comments
Type: array
Title: Approval Task Comments
The comments entered by the approver, if any, while approving or rejecting an approval task.
Show Source
Nested Schema : requisitionLifecycleDetails-purchaseOrderHistoryDetails-purchaseOrderApprovalHistoryDetails-approvalTaskComments-item-response
Type: object
Show Source
Nested Schema : requisitionLifecycleDetails-receipts-item-response
Type: object
Show Source
Nested Schema : requisitionLifecycleDetails-requisitionHistoryDetails-item-response
Type: object
Show Source
Nested Schema : Requisition Approval History Details
Type: array
Title: Requisition Approval History Details
The detailed history of all actions such as approve or reject taken on a requisition.
Show Source
Nested Schema : requisitionLifecycleDetails-requisitionHistoryDetails-approvalHistoryDetails-item-response
Type: object
Show Source
Nested Schema : Approval Task Comments
Type: array
Title: Approval Task Comments
The comments entered by the approver, if any, while approving or rejecting an approval task.
Show Source
Nested Schema : requisitionLifecycleDetails-requisitionHistoryDetails-approvalHistoryDetails-approvalTaskComments-item-response
Type: object
Show Source
Nested Schema : requisitionLifecycleDetails-requisitionLines-item-response
Type: object
Show Source
Nested Schema : requisitionLifecycleDetails-shipments-item-response
Type: object
Show Source
Nested Schema : requisitionLifecycleDetails-transferOrderHistoryDetails-item-response
Type: object
Show Source
Back to Top

Examples

This example describes how to get the header of the requisition lifecycle details resource.

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/requisitionLifecycleDetails/RequisitionHeaderId"

For example:

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

Example Response Body

The following example includes the contents of the response body in JSON format:
{
    "RequisitionHeaderId": 300100584570884,
    "Requisition": "10506447",
}
Back to Top