Get all lines
get
/fscmRestApi/resources/11.13.18.05/externalPurchasePricesChangeOrders/{HeaderChangeId}/child/lines
Request
Path Parameters
-
HeaderChangeId(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=
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 -
finder: string
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 change order lines according to the primary key.
Finder Variables- LineChangeId; integer; Value that uniquely identifies the change order line.
- PrimaryKey Finds change order lines according to the primary key.
-
limit: integer
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.
-
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 -
offset: integer
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.
-
onlyData: boolean
The resource item payload will be filtered in order to contain only data (no links section, for example).
-
orderBy: string
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
-
q: string
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:- Action; string; Action to perform on the lines. Valid values include CREATE, UPDATE, or CANCEL. This is a mandatory attribute.
- ActionCode; string; Abbreviation that identifies the action to perform on the lines.
- AdjustedPrice; number; Value of the unit price after adjustment.
- AdjustmentPercentage; number; Percent value by which the base price is adjusted.
- CancelledFlag; boolean; Contains one of the following values: true or false. If true, then the change order is canceled. If false, then the change order is active. The default value is true.
- CategoryName; string; Name of the purchasing category.
- ErrorFlag; boolean; Contains one of the following values: true or false. If true, then an error exists in the change order. If false, then there is no error in the change order. This attribute doesn't have a default value.
- HeaderChangeId; integer; Value that uniquely identifies the change order.
- InventoryItemId; integer; Unique identifier representing the master item.
- ItemDescription; string; Description of the item.
- ItemNumber; string; Number that uniquely identifies the item.
- LastUpdateDate; string; Date and time when the user most recently updated the change order line record.
- LineChangeId; integer; Value that uniquely identifies the change order line.
- LineEndDate; string; Date when the change order line becomes ineffective.
- LineNumber; integer; Number that uniquely identifies the change order line.
- LineStartDate; string; Date when the change order line becomes effective.
- ManufacturerPartNumber; string; Number that uniquely identifies the manufacturer part.
- ObjectVersionNumber; integer; Number of times the change order line has been updated.
- OldAdjustedPrice; number; Old value of the unit price after adjustment.
- OldAdjustmentPercentage; number; Old percent value by which the base price is adjusted.
- OldItemDescription; string; Old value of the description of the item.
- OldLineEndDate; string; Old value of the date when the change order line becomes ineffective.
- OldLineStartDate; string; Old value of the date when the change order line becomes effective.
- OldPrice; number; Old value of the unit price before adjustment.
- OldVendorPartNumber; string; Old value of the number that uniquely identifies the supplier part.
- Price; number; Value of the unit price before adjustment.
- PurchasingCategoryId; integer; Value that uniquely identifies the purchasing category.
- SelectionEnabledFlag; boolean; Contains one of these values: true or false. If true, then the line is eligible for selection. If false, then line isn't enabled for selection. The default value is true.
- SourceReferenceId; string; Value that uniquely identifies the external purchase prices in the source application.
- UOMCode; string; Abbreviation that identifies the unit of measure.
- UnitOfMeasure; string; Name of the unit of measure.
- UserSelectedFlag; boolean; Contains one of these values: true or false. If true, then the line is selected by the user for creating purchase agreements. If false, then the line isn't selected by the user. The default value is false.
- ValidationOrgId; integer; Unique identifier representing the item validation organization.
- VendorPartNumber; string; Number that uniquely identifies the supplier part.
-
totalResults: boolean
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
-
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:
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.
Root Schema : externalPurchasePricesChangeOrders-lines
Type:
Show Source
object
-
count(required): integer
The number of resource instances returned in the current range.
-
hasMore(required): boolean
Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false.
-
items: array
Items
Title:
Items
The items in the collection. -
limit(required): integer
The actual paging size used by the server.
-
links(required): array
Links
Title:
Links
The link relations associated with the resource instance. -
offset(required): integer
The offset value used in the current page.
-
totalResults: integer
The estimated row count when "?totalResults=true", otherwise the count is not included.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : externalPurchasePricesChangeOrders-lines-item-response
Type:
Show Source
object
-
Action: string
Title:
Meaning
Read Only:true
Maximum Length:80
Action to perform on the lines. Valid values include CREATE, UPDATE, or CANCEL. This is a mandatory attribute. -
ActionCode: string
Maximum Length:
25
Abbreviation that identifies the action to perform on the lines. -
AdjustedPrice: number
Value of the unit price after adjustment.
-
AdjustmentPercentage: number
Percent value by which the base price is adjusted.
-
CancelledFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then the change order is canceled. If false, then the change order is active. The default value is true. -
CategoryName: string
Read Only:
true
Maximum Length:2400
Name of the purchasing category. -
ErrorFlag: boolean
Maximum Length:
1
Contains one of the following values: true or false. If true, then an error exists in the change order. If false, then there is no error in the change order. This attribute doesn't have a default value. -
HeaderChangeId: integer
(int64)
Value that uniquely identifies the change order.
-
InventoryItemId: integer
(int64)
Unique identifier representing the master item.
-
ItemDescription: string
Maximum Length:
240
Description of the item. -
ItemNumber: string
Maximum Length:
300
Number that uniquely identifies the item. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time when the user most recently updated the change order line record. -
LineChangeId: integer
(int64)
Value that uniquely identifies the change order line.
-
LineEndDate: string
(date)
Date when the change order line becomes ineffective.
-
LineNumber: integer
(int64)
Number that uniquely identifies the change order line.
-
LineStartDate: string
(date)
Date when the change order line becomes effective.
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
ManufacturerPartNumber: string
Maximum Length:
700
Number that uniquely identifies the manufacturer part. -
ObjectVersionNumber: integer
(int32)
Number of times the change order line has been updated.
-
OldAdjustedPrice: number
Read Only:
true
Old value of the unit price after adjustment. -
OldAdjustmentPercentage: number
Read Only:
true
Old percent value by which the base price is adjusted. -
OldItemDescription: string
Read Only:
true
Old value of the description of the item. -
OldLineEndDate: string
Read Only:
true
Old value of the date when the change order line becomes ineffective. -
OldLineStartDate: string
Read Only:
true
Old value of the date when the change order line becomes effective. -
OldPrice: number
Read Only:
true
Old value of the unit price before adjustment. -
OldVendorPartNumber: string
Read Only:
true
Old value of the number that uniquely identifies the supplier part. -
Price: number
Value of the unit price before adjustment.
-
PurchasingCategoryId: integer
(int64)
Value that uniquely identifies the purchasing category.
-
SelectionEnabledFlag: boolean
Maximum Length:
1
Contains one of these values: true or false. If true, then the line is eligible for selection. If false, then line isn't enabled for selection. The default value is true. -
SourceReferenceId: string
Maximum Length:
30
Value that uniquely identifies the external purchase prices in the source application. -
UnitOfMeasure: string
Title:
UOM Name
Read Only:true
Maximum Length:25
Name of the unit of measure. -
UOMCode: string
Maximum Length:
3
Abbreviation that identifies the unit of measure. -
UserSelectedFlag: boolean
Maximum Length:
1
Contains one of these values: true or false. If true, then the line is selected by the user for creating purchase agreements. If false, then the line isn't selected by the user. The default value is false. -
ValidationOrgId: integer
(int64)
Unique identifier representing the item validation organization.
-
VendorPartNumber: string
Maximum Length:
300
Number that uniquely identifies the supplier part.
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.