Get all lines

get

/fscmRestApi/resources/11.13.18.05/draftPurchaseAgreements/{draftPurchaseAgreementsUniqID}/child/lines

Request

Path Parameters
  • This is the hash key of the attributes which make up the composite key for the Draft Purchase Agreements resource and used to uniquely identify an instance of Draft Purchase Agreements. The client should not generate the hash key value. Instead, the client should query on the Draft Purchase Agreements collection resource in order to navigate to a specific instance of Draft Purchase Agreements to get the hash key.
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
  • 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 Finds agreement lines according to their primary key.
      Finder Variables
      • AgreementLineId; integer; Value that uniquely identifies the agreement line.
  • 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:
    • AgreementHeaderId; integer; Value that uniquely identifies the purchase agreement.
    • AgreementLineId; integer; Value that uniquely identifies the agreement line.
    • CancelFlag; boolean; Indicates whether the agreement line is canceled. Possible values: Y and N.
    • CancelReason; string; Reason provided for canceling the agreement line.
    • CancelledBy; integer; User who canceled the purchase agreement line.
    • Category; string; Value that uniquely identifies the purchasing category.
    • CategoryCode; string; Abbreviation that identifies the purchasing category.
    • CategoryId; integer; Value that uniquely identifies the purchasing category.
    • EntityChangeTypeCode; string; Indicates whether the record is new or changed.
    • IsLineApprovedOnceFlag; boolean; Indicates whether a line has been approved at least once.
    • Item; string; Abbreviation that uniquely identifies the item on the purchase agreement line.
    • ItemAllowItemDescriptionUpdateFlag; boolean; Value that identifies whether item descriptions can be updated on document lines.
    • ItemId; integer; Value that uniquely identifies the item on the purchase agreement.
    • ParentItem; string; Value that uniquely identifies the parent option class or model for the item.
    • ParentItemId; integer; Value that uniquely identifies the parent option class or model for the item.
    • PimItemCategory; string; Name of the purchasing category associated with the item.
    • PimItemCategoryCode; string; Abbreviation that identifies the purchasing category associated with the item.
    • PimItemCategoryId; integer; Value that uniquely identifies the purchasing category associated with the item.
    • PimItemDescription; string; Description of the item that the purchase order line references.
    • PriceBreakType; string; Value that identifies the pricing scheme for the price breaks of this line.
    • ReasonForChange; string; Value that identifies the reason for changing the line.
    • ReceivedQuantity; number; Quantity received for an agreement line.
    • StatusCode; string; Code that identifies the agreement line status.
    • TopModel; string; Value that identifies the top model associated with the option or option class or submodel.
    • TopModelId; integer; Value that uniquely identifies the top model associated with the option, option class, or submodel.
  • 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 : draftPurchaseAgreements-lines
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : draftPurchaseAgreements-lines-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : Item Attributes
Type: array
Title: Item Attributes
Agreement item attribute captures additional information about the item on the agreement line such as supplier item auxiliary identifier, supplier URL, manufacturer name, manufacturer URL, manufacturer part number, United Nations Standard Products and Services Code, UNSPSC, and image URL. For example, Big Computers could be the manufacturer of a laptop whereas B004521 could be the manufacturer part number for a television.
Show Source
Nested Schema : Price Breaks
Type: array
Title: Price Breaks
Agreement price breaks are reductions in the price of an item depending on certain conditions such as purchasing in bulk or from a certain location. For example, for a laptop, price will be reduced by 100 dollars if your order exceeds 20 quantity or 30 dollars if you order for a specific location.
Show Source
Nested Schema : draftPurchaseAgreements-lines-attachments-item-response
Type: object
Show Source
Nested Schema : draftPurchaseAgreements-lines-DFF-item-response
Type: object
Show Source
Nested Schema : draftPurchaseAgreements-lines-itemAttributes-item-response
Type: object
Show Source
  • Read Only: true
    Value that uniquely identifies the agreement line.
  • Maximum Length: 700
    Alternate identifier for an item specified on a blanket purchase agreement line.
  • Maximum Length: 700
    URL of the attachment associated with the item.
  • Value that uniquely identifies the purchasing extended item attributes. This is the primary key of the Purchasing Attribute Values view object.
  • Value that uniquely identifies the purchasing item translation attributes. This is the primary key of the Purchasing Attribute Values Translation view object.
  • Maximum Length: 700
    Status of the item availability from supplier.
  • Maximum Length: 700
    Additional comments for the item specified on the blanket purchase agreement line.
  • Read Only: true
    Maximum Length: 64
    User who created the item attributes for a purchase agreement line.
  • Read Only: true
    Date and time when the buyer or application created the item attributes for a purchase agreement line.
  • DFF
  • Read Only: true
    Maximum Length: 1
    Value that identifies if the row is new or changed.
  • Title: Hazard Class
    Read Only: true
    Maximum Length: 40
    Name of the hazard class.
  • Title: Code
    Read Only: true
    Maximum Length: 30
    Abbreviation that identifies the hazard class.
  • Read Only: true
    Value that uniquely identifies the hazard class.
  • Maximum Length: 700
    URL of the image file associated with the item specified on a blanket purchase agreement line.
  • Read Only: true
    Date and time when the buyer or application last updated the item attributes on a purchase agreement line.
  • Read Only: true
    Maximum Length: 64
    User who last updated the item attributes on a purchase agreement line.
  • Number of days in which the item specified on the blanket purchase agreement line can be delivered when ordered.
  • Links
  • Maximum Length: 4000
    Text describing the long description of the item specified on a blanket purchase agreement line.
  • Maximum Length: 700
    Name of the manufacturer of the item specified on a blanket purchase agreement line.
  • Maximum Length: 700
    Part number used to identify the item by the manufacturer of the item, that's specified on a blanket purchase agreement line.
  • Maximum Length: 700
    URL of the manufacturer of the item specified on a blanket purchase agreement line.
  • Maximum Length: 240
    String that describes how the item is packed by the supplier.
  • Attribute indicating how to round the quantity on an internal requisition that results from conversions between the requisition line unit of measure and the item unit of issue.
  • Read Only: true
    Maximum Length: 255
    Supplier item auxiliary identifier for the blanket agreement line.
  • Maximum Length: 700
    URL of the supplier's organization.
  • Maximum Length: 700
    Location of the small version of a larger image file for the item specified on the blanket purchase agreement.
  • Title: UN Number
    Read Only: true
    Maximum Length: 20
    Number that the United Nations uses to identify hazardous material.
  • Title: UN Number Description
    Read Only: true
    Maximum Length: 240
    Description of the hazardous material that the United Nations identification number references.
  • Read Only: true
    Value that uniquely identifies the number that the United Nations uses to identify hazardous material.
  • Maximum Length: 700
    The United Nations Standard Products and Services Code for the item specified on the blanket purchase agreement.
Nested Schema : DFF
Type: array
Show Source
Nested Schema : draftPurchaseAgreements-lines-itemAttributes-DFF-item-response
Type: object
Show Source
Nested Schema : draftPurchaseAgreements-lines-priceBreaks-item-response
Type: object
Show Source
Nested Schema : Attachments
Type: array
Title: Attachments
The attachments resource is used to view, create, and update attachments.
Show Source
Nested Schema : DFF
Type: array
Show Source
Nested Schema : draftPurchaseAgreements-lines-priceBreaks-attachments-item-response
Type: object
Show Source
Nested Schema : draftPurchaseAgreements-lines-priceBreaks-DFF-item-response
Type: object
Show Source
Back to Top