Jump to

• Request
• Response

Get one workflow line

get

/fscmRestApi/resources/11.13.18.05/productChangeLines/{ChangeLineId}

Request

Path Parameters

• ChangeLineId(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
• 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 Top

Response

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.

Body ()

Root Schema : productChangeLines-item-response

Type: object

Show Source

• BaseChangeType: string
  Read Only: true

  Maximum Length: 30

  Base type of the workflow object.
• ChangeAssignedTo: string
  Read Only: true

  Maximum Length: 100

  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.
• 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.
• 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.
• 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: 100

  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.
• ItemId: integer (int64)
  Read Only: true

  Value that uniquely identifies the workflow line item ID.
• LifecyclePhaseValue: string
  Read Only: true

  Maximum Length: 80

  Value of the workflow line life cycle phase.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• NewItemRevision: string
  Read Only: true

  Maximum Length: 18

  Value of the new item revision of the workflow line item.
• OldItemRevision: string
  Read Only: true

  Maximum Length: 18

  Value of the old item revision of the workflow line item.

{
    "type":"object",
    "properties":{
        "BaseChangeType":{
            "maxLength":"30",
            "type":"string",
            "description":"Base type of the workflow object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeStatusTypeValue":{
            "maxLength":"240",
            "type":"string",
            "description":"Value of the status type of the workflow object. Valid values are open, interim approval, approval, scheduled, and completed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeStatusCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the status of the workflow object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChangeOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the workflow organization ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChangeLineStatusCodeValue":{
            "maxLength":"80",
            "type":"string",
            "description":"Value that uniquely identifies the status of the workflow line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeRequestedBy":{
            "maxLength":"100",
            "type":"string",
            "description":"User who requested the workflow object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the workflow object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeStatusType":{
            "type":"integer",
            "description":"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.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChangeRequestorId":{
            "maxLength":"64",
            "type":"string",
            "description":"Value that determines the user who requested the workflow object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeLineStatusCode":{
            "type":"integer",
            "description":"Abbreviation that identifies the status of the workflow line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChangeTypeCategoryCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Category code value of the type of workflow.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ItemId":{
            "type":"integer",
            "description":"Value that uniquely identifies the workflow line item ID.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChangeAssignedTo":{
            "maxLength":"100",
            "type":"string",
            "description":"User who the workflow object is assigned to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LifecyclePhaseValue":{
            "maxLength":"80",
            "type":"string",
            "description":"Value of the workflow line life cycle phase.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangePriorityValue":{
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that identifies the priority of the workflow object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NewItemRevision":{
            "maxLength":"18",
            "type":"string",
            "description":"Value of the new item revision of the workflow line item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeDescription":{
            "maxLength":"2000",
            "type":"string",
            "description":"Description of the workflow object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChangeLineImplementationDate":{
            "type":"string",
            "description":"Date when the workflow line was implemented.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OldItemRevision":{
            "maxLength":"18",
            "type":"string",
            "description":"Value of the old item revision of the workflow line item.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeTypeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the type of workflow object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangePriorityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the priority of the workflow object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies the workflow line.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "changeDFF":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/productChangeLines-changeDFF-item-response"
            },
            "x-cardinality":"1"
        },
        "ChangeCreationDate":{
            "type":"string",
            "description":"Date when the workflow object was created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeReasonValue":{
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that identifies the reason of the workflow object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeAssigneeId":{
            "maxLength":"64",
            "type":"string",
            "description":"Value that determines the user who the workflow object is assigned to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeId":{
            "type":"integer",
            "description":"Value that uniquely identifies the workflow.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChangeStatusCodeValue":{
            "maxLength":"240",
            "type":"string",
            "description":"Abbreviation that identifies the status of the workflow object. Valid values are open, interim approval, approval, scheduled, and completed.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeNotice":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that uniquely identifies the workflow object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeReasonCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Abbreviation that identifies the reason of the workflow object.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ChangeLineOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization of the workflow object.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ChangeTypeName":{
            "maxLength":"80",
            "type":"string",
            "description":"Name of the type of workflow.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : changeDFF

Type: array

Show Source

• Array of: object productChangeLines-changeDFF-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/productChangeLines-changeDFF-item-response"
    },
    "x-cardinality":"1"
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : productChangeLines-changeDFF-item-response

Type: object

Show Source

• __FLEX_Context: string
  Title: Context Segment

  Maximum Length: 30
• BaseChangeMgmtTypeCode: string
  Maximum Length: 30
• ChangeId: integer (int64)
• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{
    "type":"object",
    "properties":{
        "ChangeId":{
            "type":"integer",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "precision":"18"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "BaseChangeMgmtTypeCode":{
            "maxLength":"30",
            "type":"string",
            "nullable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide"
            },
            "x-queryable":true
        },
        "__FLEX_Context":{
            "title":"Context Segment",
            "maxLength":"30",
            "type":"string",
            "nullable":true,
            "x-hints":{
                "FND_ACFF_DerivedFromParameter":"PRODUCT_CONTEXT",
                "FND_ACFF_ValueSetInfo":"ORA_EGO_CHANGE_TYPES_VS#TABLE",
                "controlType":"choice",
                "includeInCompactView":true,
                "FND_ACFF_IsDiscriminator":"true",
                "FND_ACFF_DV":"PRODUCT_CONTEXT",
                "FND_ACFF_DVT":"P",
                "FND_ACFF_JavaType":"java.lang.String",
                "FND_ACFF_PreferredDisplayType":"TEXT_BOX"
            },
            "x-oj":{
                "transform":{
                    "path":"oj-sp/common-util/flex-util",
                    "name":"transformFlexUIHints"
                }
            },
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• 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.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Links

changeDFF

Operation: /fscmRestApi/resources/11.13.18.05/productChangeLines/{ChangeLineId}/child/changeDFF

Parameters:

• ChangeLineId: $request.path.ChangeLineId

Back to Top