Get all workflow lines
get
/fscmRestApi/resources/11.13.18.05/productChangeLines
Request
Query Parameters
-
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 a product workflow line according to the primary key.
Finder Variables- ChangeLineId; integer; Finds a product workflow line by the workflow line ID.
- PrimaryKey Finds a product workflow line 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:- BaseChangeType; string; Base type of the workflow object.
- ChangeAssignedTo; string; User who the workflow object is assigned to.
- ChangeAssigneeId; string; Value that determines the user who the workflow object is assigned to.
- ChangeCreationDate; string; Date when the workflow object was created.
- ChangeDescription; string; Description of the workflow object.
- ChangeId; integer; Value that uniquely identifies the workflow.
- ChangeLineCreationDate; string; Date when the workflow line was created.
- ChangeLineId; integer; Value that uniquely identifies the workflow line.
- ChangeLineImplementationDate; string; Date when the workflow line was implemented.
- ChangeLineOrganizationId; integer; Value that uniquely identifies the organization of the workflow object.
- ChangeLineScheduledDate; string; Date when the workflow line will get implemented.
- ChangeLineSequenceNumber; number; Value of the sequence number of the workflow line.
- ChangeLineStatusCode; integer; Abbreviation that identifies the status of the workflow line.
- ChangeLineStatusCodeValue; string; Value that uniquely identifies the status of the workflow line.
- ChangeLineVersionId; integer; Value that uniquely identifies the version of the workflow line.
- ChangeName; string; Name of the workflow object.
- ChangeNotice; string; Value that uniquely identifies the workflow object.
- ChangeOrganizationId; integer; Value that uniquely identifies the workflow organization ID.
- ChangePriorityCode; string; Abbreviation that identifies the priority of the workflow object.
- ChangePriorityValue; string; Abbreviation that identifies the priority of the workflow object.
- ChangeReasonCode; string; Abbreviation that identifies the reason of the workflow object.
- ChangeReasonValue; string; Abbreviation that identifies the reason of the workflow object.
- ChangeRequestedBy; string; User who requested the workflow object.
- ChangeRequestorId; string; Value that determines the user who requested the workflow object.
- ChangeStatusCode; integer; Abbreviation that identifies the status of the workflow object.
- ChangeStatusCodeValue; string; Abbreviation that identifies the status of the workflow object. Valid values are open, interim approval, approval, scheduled, and completed.
- ChangeStatusType; integer; Type of status of the workflow object. Valid values are open, interim approval, approval, scheduled, and completed. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Change Statuses task.
- ChangeStatusTypeValue; string; Value of the status type of the workflow object. Valid values are open, interim approval, approval, scheduled, and completed.
- ChangeTypeCategoryCode; string; Category code value of the type of workflow.
- ChangeTypeId; integer; Value that uniquely identifies the type of workflow object.
- ChangeTypeName; string; Name of the type of workflow.
- ItemCatalogGroupId; integer; Value that uniquely identifies the workflow line item catalog group ID.
- ItemClassName; string; Value of the item class of the workflow line item.
- ItemDescription; string; Value of the description of the workflow line item.
- ItemId; integer; Value that uniquely identifies the workflow line item ID.
- ItemNumber; string; Value of the item number of the workflow line item.
- LifecyclePhaseValue; string; Value of the workflow line life cycle phase.
- LineActivationRequestId; integer; Value of the activation process request ID of the workflow line item.
- LineActivationRequestStatus; string; Value of the activation process status of the workflow line item.
- LineScheduledRequestId; integer; Value of the scheduled process request ID of the workflow line item.
- LineScheduledRequestStatus; string; Value of the scheduled process status of the workflow line item.
- NewItemClassId; integer; Value that uniquely identifies the workflow line new item class ID.
- NewItemRevision; string; Value of the new item revision of the workflow line item.
- NewItemRevisionId; string; The unique identifier of the new item revision.
- NewLifecylePhaseValue; string; Value of the new lifecycle phase of the workflow line item.
- OldItemRevision; string; Value of the old item revision of the workflow line item.
- OldItemRevisionId; string; The unique identifier of the old item revision.
- OldLifeyclePhaseValue; string; Value of the old lifecycle phase of the workflow line item.
- UseUpItemId; integer; Value that uniquely identifies the use-up item number.
- UseUpItemNumber; string; Value of the use-up item of the workflow line item.
- UseUpPlanName; string; Value of the use-up plan name of the workflow line item.
-
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: string
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: string
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 : productChangeLines
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 : productChangeLines-item-response
Type:
Show Source
object
-
BaseChangeType: string
Read Only:
true
Maximum Length:30
Base type of the workflow object. -
ChangeAssignedTo: string
Read Only:
true
Maximum Length:255
User who the workflow object is assigned to. -
ChangeAssigneeId: string
Read Only:
true
Maximum Length:64
Value that determines the user who the workflow object is assigned to. -
ChangeCreationDate: string
(date-time)
Read Only:
true
Date when the workflow object was created. -
ChangeDescription: string
Read Only:
true
Maximum Length:2000
Description of the workflow object. -
changeDFF: array
changeDFF
-
ChangeId: integer
(int64)
Read Only:
true
Value that uniquely identifies the workflow. -
ChangeLineCreationDate: string
(date-time)
Read Only:
true
Date when the workflow line was created. -
changeLineDFF: array
changeLineDFF
-
ChangeLineId: integer
(int64)
Read Only:
true
Value that uniquely identifies the workflow line. -
ChangeLineImplementationDate: string
(date-time)
Read Only:
true
Date when the workflow line was implemented. -
ChangeLineOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the organization of the workflow object. -
ChangeLineScheduledDate: string
(date-time)
Read Only:
true
Date when the workflow line will get implemented. -
ChangeLineSequenceNumber: number
Read Only:
true
Value of the sequence number of the workflow line. -
ChangeLineStatusCode: integer
(int64)
Read Only:
true
Abbreviation that identifies the status of the workflow line. -
ChangeLineStatusCodeValue: string
Read Only:
true
Maximum Length:80
Value that uniquely identifies the status of the workflow line. -
ChangeLineVersionId: integer
(int64)
Read Only:
true
Value that uniquely identifies the version of the workflow line. -
ChangeName: string
Read Only:
true
Maximum Length:240
Name of the workflow object. -
ChangeNotice: string
Read Only:
true
Maximum Length:50
Value that uniquely identifies the workflow object. -
ChangeOrganizationId: integer
(int64)
Read Only:
true
Value that uniquely identifies the workflow organization ID. -
ChangePriorityCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the priority of the workflow object. -
ChangePriorityValue: string
Read Only:
true
Maximum Length:80
Abbreviation that identifies the priority of the workflow object. -
ChangeReasonCode: string
Read Only:
true
Maximum Length:30
Abbreviation that identifies the reason of the workflow object. -
ChangeReasonValue: string
Read Only:
true
Maximum Length:80
Abbreviation that identifies the reason of the workflow object. -
ChangeRequestedBy: string
Read Only:
true
Maximum Length:255
User who requested the workflow object. -
ChangeRequestorId: string
Read Only:
true
Maximum Length:64
Value that determines the user who requested the workflow object. -
ChangeStatusCode: integer
(int64)
Read Only:
true
Abbreviation that identifies the status of the workflow object. -
ChangeStatusCodeValue: string
Read Only:
true
Maximum Length:240
Abbreviation that identifies the status of the workflow object. Valid values are open, interim approval, approval, scheduled, and completed. -
ChangeStatusType: integer
(int64)
Read Only:
true
Type of status of the workflow object. Valid values are open, interim approval, approval, scheduled, and completed. Review and update the value for this attribute using the Setup and Maintenance work area, and the Manage Change Statuses task. -
ChangeStatusTypeValue: string
Read Only:
true
Maximum Length:240
Value of the status type of the workflow object. Valid values are open, interim approval, approval, scheduled, and completed. -
ChangeTypeCategoryCode: string
Read Only:
true
Maximum Length:30
Category code value of the type of workflow. -
ChangeTypeId: integer
Read Only:
true
Value that uniquely identifies the type of workflow object. -
ChangeTypeName: string
Read Only:
true
Maximum Length:80
Name of the type of workflow. -
ItemCatalogGroupId: integer
(int64)
Read Only:
true
Value that uniquely identifies the workflow line item catalog group ID. -
ItemClassName: string
Read Only:
true
Maximum Length:80
Value of the item class of the workflow line item. -
ItemDescription: string
Read Only:
true
Maximum Length:240
Value of the description of the workflow line item. -
ItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the workflow line item ID. -
ItemNumber: string
Read Only:
true
Maximum Length:300
Value of the item number of the workflow line item. -
LifecyclePhaseValue: string
Read Only:
true
Maximum Length:80
Value of the workflow line life cycle phase. -
LineActivationRequestId: integer
(int64)
Read Only:
true
Value of the activation process request ID of the workflow line item. -
LineActivationRequestStatus: string
Read Only:
true
Maximum Length:255
Value of the activation process status of the workflow line item. -
LineScheduledRequestId: integer
(int64)
Read Only:
true
Value of the scheduled process request ID of the workflow line item. -
LineScheduledRequestStatus: string
Read Only:
true
Maximum Length:255
Value of the scheduled process status of the workflow line item. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NewItemClassId: integer
(int64)
Read Only:
true
Value that uniquely identifies the workflow line new item class ID. -
NewItemRevision: string
Read Only:
true
Maximum Length:18
Value of the new item revision of the workflow line item. -
NewItemRevisionId: string
Read Only:
true
Maximum Length:21
The unique identifier of the new item revision. -
NewLifecylePhaseValue: string
Read Only:
true
Maximum Length:80
Value of the new lifecycle phase of the workflow line item. -
OldItemRevision: string
Read Only:
true
Maximum Length:18
Value of the old item revision of the workflow line item. -
OldItemRevisionId: string
Read Only:
true
Maximum Length:21
The unique identifier of the old item revision. -
OldLifeyclePhaseValue: string
Read Only:
true
Maximum Length:80
Value of the old lifecycle phase of the workflow line item. -
ProductLines: string
(byte)
Read Only:
true
Value of the product lines of the workflow line item. -
UseUpItemId: integer
(int64)
Read Only:
true
Value that uniquely identifies the use-up item number. -
UseUpItemNumber: string
Read Only:
true
Maximum Length:300
Value of the use-up item of the workflow line item. -
UseUpPlanName: string
Read Only:
true
Maximum Length:30
Value of the use-up plan name of the workflow line item.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : productChangeLines-changeDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context Segment -
BaseChangeMgmtTypeCode: string
Maximum Length:
30
-
ChangeId: integer
(int64)
-
links: array
Links
Title:
Links
The link relations associated with the resource instance.
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.
Nested Schema : productChangeLines-changeLineDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Context Segment -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Context Segment -
ChangeLineId: integer
(int64)
Read Only:
true
-
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
SubjectInternalName: string
Maximum Length:
30
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source