REST API for Oracle Fusion Cloud SCM

Get one header

get

/fscmRestApi/resources/11.13.18.05/inventoryMovementRequestLines/{LineId}/child/header/{HeaderId}

Request

Path Parameters

HeaderId(required): integer(int64)

Value that uniquely identifies the movement request header.
LineId(required): integer(int64)

Value that uniquely identifies the movement request line.

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

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.

Root Schema : inventoryMovementRequestLines-header-item-response

Type: object

Show Source

ActionSourceCode: string

Value that represents the source system that performed this action.
CopyLinesFromHeaderId: integer

Value that uniquely identifies a movement request header from which lines needs to be duplicated.
CopyLinesFromLineId: integer

Value that uniquely identifies a movement request line that needs to be duplicated.
CreatedBy: string

Title: Created By

Read Only: true

Maximum Length: 64

Name of the user who created the line in a movement request.
Description: string

Title: Description

Maximum Length: 240

Description of the movement request.
DestinationAccount: string

Maximum Length: 255

Number that indicates the destination account for the movement request.
DestinationAccountAlias: string

Read Only: true

Value that identifies the destination account alias.
DestinationAccountId: integer (int64)

Title: Destination Account

Value that uniquely identifies the destination account.
DestinationLocator: string

Description of the destination stock locator.
DestinationLocatorId: integer (int64)

Title: Destination Locator

Value that uniquely identifies the destination stock locator.
DestinationSubinventory: string

Title: Destination Subinventory

Maximum Length: 10

Abbreviation that identifies the destination subinventory.
ExternalSystemGroupId: integer (int64)

Read Only: true

Value that uniquely identifies the movement request headers that need to be interfaced with an external system.
HeaderId: integer (int64)

Read Only: true

Value that uniquely identifies the movement request header.
links: array Links

Title: Links

The link relations associated with the resource instance.
MovementRequestType: string

Read Only: true

Maximum Length: 255

Name of the movement request type.
MoveOrderType: integer

Title: Movement Request Type

Read Only: true

Default Value: 1

Value that uniquely identifies the type of the movement request.
OrganizationCode: string

Maximum Length: 255

Abbreviation that identifies the organization.
OrganizationId: integer (int64)

Value that uniquely identifies the organization.
OrganizationName: string

Maximum Length: 255

Name of the source organization.
PickSetEnabledFlag: boolean

Read Only: true

Contains one of the following values: True or False. If True, then the pick set is enabled. If False, then the pick set is disabled.
RequestNumber: string

Title: Movement Request

Maximum Length: 30

Number that identifies the movement request.
RequiredDate: string (date-time)

Title: Required Date

Date when the movement request is required.
SourceLocator: string

Description of the source stock locator.
SourceLocatorId: integer (int64)

Title: Source Locator

Value that uniquely identifies the source stock locator.
SourceSubinventory: string

Title: Source Subinventory

Maximum Length: 10

Abbreviation that identifies the source subinventory.
Status: string

Maximum Length: 255

Value that indicates the status for the movement request header.
StatusCode: integer (int64)

Title: Status

Default Value: 1

Value that uniquely identifies the header status for the movement request. A list of accepted values is defined in the lookup type INV_TXN_REQUEST_STATUS.
SubmitApprovalFlag: boolean

Default Value: false

Contains one of the following values: True or False. If True, then the movement request is submitted for approval. If False, then the movement request isn't submitted for approval. The default value is False.
SubmitRequestFlag: boolean

Contains one of the following values: True or False. If True, then the movement request is submitted. If False, then the movement request isn't submitted. The default value is False.
TransactionType: string

Maximum Length: 255

Name of the transaction type.
TransactionTypeId: integer (int64)

Title: Transaction Type

Value that uniquely identifies the type of the transaction.

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the source organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SubmitApprovalFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: True or False. If True, then the movement request is submitted for approval. If False, then the movement request isn't submitted for approval. The default value is False.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DestinationAccountId":{
            "title":"Destination Account",
            "type":"integer",
            "description":"Value that uniquely identifies the destination account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "TransactionType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the transaction type.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "CopyLinesFromHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies a movement request header from which lines needs to be duplicated.",
            "nullable":true,
            "x-queryable":false
        },
        "Description":{
            "title":"Description",
            "maxLength":240,
            "type":"string",
            "description":"Description of the movement request.",
            "nullable":true,
            "x-queryable":true
        },
        "PickSetEnabledFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: True or False. If True, then the pick set is enabled. If False, then the pick set is disabled.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "HeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the movement request header.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"false"
            },
            "x-queryable":true
        },
        "TransactionTypeId":{
            "title":"Transaction Type",
            "type":"integer",
            "description":"Value that uniquely identifies the type of the transaction.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ExternalSystemGroupId":{
            "type":"integer",
            "description":"Value that uniquely identifies the movement request headers that need to be interfaced with an external system.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status",
            "type":"integer",
            "description":"Value that uniquely identifies the header status for the movement request. A list of accepted values is defined in the lookup type INV_TXN_REQUEST_STATUS.",
            "format":"int64",
            "nullable":true,
            "default":1,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"INV_TXN_REQUEST_STATUS",
                "precision":18,
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "RequestNumber":{
            "title":"Movement Request",
            "maxLength":30,
            "type":"string",
            "description":"Number that identifies the movement request.",
            "nullable":false,
            "x-queryable":true
        },
        "MovementRequestType":{
            "maxLength":255,
            "type":"string",
            "description":"Name of the movement request type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SubmitRequestFlag":{
            "type":"boolean",
            "description":"Contains one of the following values: True or False. If True, then the movement request is submitted. If False, then the movement request isn't submitted. The default value is False.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationLocator":{
            "type":"string",
            "description":"Description of the destination stock locator.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationAccountAlias":{
            "type":"string",
            "description":"Value that identifies the destination account alias.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MoveOrderType":{
            "title":"Movement Request Type",
            "type":"integer",
            "description":"Value that uniquely identifies the type of the movement request.",
            "nullable":true,
            "readOnly":true,
            "default":1,
            "x-hints":{
                "fnd:APPLCORE_SETID_LOOKUP_TYPE":"MOVE_ORDER_TYPE",
                "fnd:APPLCORE_VIEW_APPLICATION_ID":"0"
            },
            "x-queryable":true
        },
        "OrganizationCode":{
            "maxLength":255,
            "type":"string",
            "description":"Abbreviation that identifies the organization.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "SourceLocatorId":{
            "title":"Source Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the source stock locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "DestinationAccount":{
            "maxLength":255,
            "type":"string",
            "description":"Number that indicates the destination account for the movement request.",
            "nullable":true,
            "x-queryable":true
        },
        "Status":{
            "maxLength":255,
            "type":"string",
            "description":"Value that indicates the status for the movement request header.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice",
                "dependencies":[
                    "StatusCode"
                ]
            },
            "x-queryable":true
        },
        "RequiredDate":{
            "title":"Required Date",
            "type":"string",
            "description":"Date when the movement request is required.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSubinventory":{
            "title":"Source Subinventory",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the source subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Name of the user who created the line in a movement request.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionSourceCode":{
            "type":"string",
            "description":"Value that represents the source system that performed this action.",
            "nullable":true,
            "x-queryable":false
        },
        "DestinationSubinventory":{
            "title":"Destination Subinventory",
            "maxLength":10,
            "type":"string",
            "description":"Abbreviation that identifies the destination subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "DestinationLocatorId":{
            "title":"Destination Locator",
            "type":"integer",
            "description":"Value that uniquely identifies the destination stock locator.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceLocator":{
            "type":"string",
            "description":"Description of the source stock locator.",
            "nullable":true,
            "x-queryable":false
        },
        "CopyLinesFromLineId":{
            "type":"integer",
            "description":"Value that uniquely identifies a movement request line that needs to be duplicated.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

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

createPickSlip

Operation: /fscmRestApi/resources/11.13.18.05/inventoryMovementRequestLines/{LineId}/child/header/{HeaderId}/action/createPickSlip

Parameters:

HeaderId: $request.path.HeaderId
LineId: $request.path.LineId

Creates a pick if all the mandatory attributes are available for the line.