Jump to

• Request
• Response

Get one line detail

get

/fscmRestApi/resources/11.13.18.05/partRequirementLines/{RequirementLineId}/child/lineDetails/{RequirementLineDetailId}

Request

Path Parameters

• RequirementLineDetailId(required): integer(int64)
  Value that uniquely identifies the request line details.
• RequirementLineId(required): integer(int64)
  Value that uniquely identifies the requirement 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.

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 : partRequirementLines-lineDetails-item-response

Type: object

Show Source

• ArrivalDate: string (date-time)
  Read Only: true

  Date when the item will arrive.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who created the row.
• CreationDate: string (date-time)
  Read Only: true

  Indicates the date and time of the creation of the row.
• ErrorText: string
  Maximum Length: 2000

  Value that describes the error.
• ExpectedArrivalDate: string (date-time)
  Title: Expected Arrival

  Date when the item is expected to arrive.
• ExpectedShipDate: string (date-time)
  Date when the item is expected to ship.
• LastUpdateDate: string (date-time)
  Read Only: true

  Indicates the date and time of the last update of the row.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  Indicates the user who last updated the row.
• LastUpdateLogin: string
  Read Only: true

  Maximum Length: 32

  Indicates the session login associated to the user who last updated the row.
• LineStatus: string
  Read Only: true

  Value that describes the status of the Order.
• LineStatusCode: string
  Read Only: true

  Abbreviation that identifies the status of the order.
• links: array Links
  Title: Links

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

  Maximum Length: 120

  Value that uniquely identifies the order ID.
• OrderNumber: string
  Read Only: true

  Maximum Length: 120

  Value that identifies the Order.
• RequirementLineDetailId: integer (int64)
  Title: Part Requirement Details ID

  Value that uniquely identifies the request line details.
• RequirementLineId: integer (int64)
  Title: Part Requirement Line ID

  Value that uniquely identifies the requirement line of the parts requirement line.
• ShipMethodCode: string
  Read Only: true

  Maximum Length: 522

  Value that describes the shipping method being used to ship the order which is a combination of carrier, mode of transport, and service level.
• SourceCarrierId: integer (int64)
  Title: Carrier

  Value that uniquely identifies the carrier for the possible source.
• SourceId: integer (int64)
  Title: Parts Source Order ID

  Value that uniquely identifies the source object.
• SourceModeOfTransport: string
  Title: Transportation Mode

  Maximum Length: 30

  Mode of transport for the possible source.
• SourceOrganizationCode: string
  Maximum Length: 18

  Abbreviation that identifies the source organization.
• SourceOrganizationId: integer (int64)
  Title: Source Organization ID

  Value that uniquely identifies the source organization.
• SourceOrganizationName: string
  Read Only: true

  Maximum Length: 240

  Name of the Source organization.
• SourceRequestDate: string (date-time)
  Title: Part Sourcing Request Date

  Date when the source search request was made.
• SourceServiceLevels: string
  Title: Delivery Service Level

  Maximum Length: 30

  Value that indicates the service level for the possible source.
• SourceSubinventory: string
  Title: Source Subinventory

  Maximum Length: 10

  Value that indicates the source subinventory.
• SourceType: string
  Title: Parts Source Order Type

  Maximum Length: 30

  Abbreviation that identifies the source type. Valid values are SO for Sales Order and TO for Transfer Order.

{
    "type":"object",
    "properties":{
        "ArrivalDate":{
            "type":"string",
            "description":"Date when the item will arrive.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"Indicates the date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ErrorText":{
            "maxLength":2000,
            "type":"string",
            "description":"Value that describes the error.",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedArrivalDate":{
            "title":"Expected Arrival",
            "type":"string",
            "description":"Date when the item is expected to arrive.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "ExpectedShipDate":{
            "type":"string",
            "description":"Date when the item is expected to ship.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"Indicates the session login associated to the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"Indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LineStatus":{
            "type":"string",
            "description":"Value that describes the status of the Order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LineStatusCode":{
            "type":"string",
            "description":"Abbreviation that identifies the status of the order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderId":{
            "maxLength":120,
            "type":"string",
            "description":"Value that uniquely identifies the order ID.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OrderNumber":{
            "maxLength":120,
            "type":"string",
            "description":"Value that identifies the Order.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementLineDetailId":{
            "title":"Part Requirement Details ID",
            "type":"integer",
            "description":"Value that uniquely identifies the request line details.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18,
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "RequirementLineId":{
            "title":"Part Requirement Line ID",
            "type":"integer",
            "description":"Value that uniquely identifies the requirement line of the parts requirement line.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ShipMethodCode":{
            "maxLength":522,
            "type":"string",
            "description":"Value that describes the shipping method being used to ship the order which is a combination of carrier, mode of transport, and service level.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceCarrierId":{
            "title":"Carrier",
            "type":"integer",
            "description":"Value that uniquely identifies the carrier for the possible source.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceId":{
            "title":"Parts Source Order ID",
            "type":"integer",
            "description":"Value that uniquely identifies the source object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceModeOfTransport":{
            "title":"Transportation Mode",
            "maxLength":30,
            "type":"string",
            "description":"Mode of transport for the possible source.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrganizationCode":{
            "maxLength":18,
            "type":"string",
            "description":"Abbreviation that identifies the source organization.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceOrganizationId":{
            "title":"Source Organization ID",
            "type":"integer",
            "description":"Value that uniquely identifies the source organization.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "SourceOrganizationName":{
            "maxLength":240,
            "type":"string",
            "description":"Name of the Source organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SourceRequestDate":{
            "title":"Part Sourcing Request Date",
            "type":"string",
            "description":"Date when the source search request was made.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "SourceServiceLevels":{
            "title":"Delivery Service Level",
            "maxLength":30,
            "type":"string",
            "description":"Value that indicates the service level for the possible source.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceSubinventory":{
            "title":"Source Subinventory",
            "maxLength":10,
            "type":"string",
            "description":"Value that indicates the source subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "SourceType":{
            "title":"Parts Source Order Type",
            "maxLength":30,
            "type":"string",
            "description":"Abbreviation that identifies the source type. Valid values are SO for Sales Order and TO for Transfer Order.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        }
    }
}

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."
        }
    }
}

Back to Top