Get one requirement header
get
/fscmRestApi/resources/11.13.18.05/partRequirementHeaders/{RequirementHeaderId}
Request
Path Parameters
-
RequirementHeaderId(required): integer(int64)
Value that uniquely identifies the part requirement header.
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 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 : partRequirementHeaders-item-response
Type:
Show Source
object
-
BillToAccountId: integer
(int64)
Value that uniquely identifies the bill-to customer account.
-
BillToAccountNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the bill-to customer account. -
BillToAddress: string
Read Only:
true
Maximum Length:4000
Billing address of the customer. -
BillToPartyId: integer
(int64)
Value that uniquely identifies the bill-to customer party.
-
BillToPartyName: string
Read Only:
true
Maximum Length:360
Name of the bill-to customer party. -
BillToPartySiteId: integer
(int64)
Value that uniquely identifies the bill-to party site address.
-
BUName: string
Read Only:
true
Maximum Length:240
Name of the business unit. -
BUOrgId: integer
(int64)
Value that uniquely identifies the business unit.
-
CreatedBy: string
Read Only:
true
Maximum Length:64
User who created the row. -
CreationDate: string
(date-time)
Read Only:
true
Date and time the row was created. -
DestinationOrganizationCode: string
Maximum Length:
80
Abbreviation that identifies the destination organization. -
DestinationOrganizationId: integer
(int64)
Value that uniquely identifies the destination organization.
-
DestinationOrganizationName: string
Read Only:
true
Maximum Length:240
Name of the destination organization. -
DestinationSubinventory: string
Maximum Length:
10
Name of the destination subinventory. -
LastUpdateDate: string
(date-time)
Read Only:
true
Date and time of the last update of the row. -
LastUpdatedBy: string
Read Only:
true
Maximum Length:64
User who last updated the row. -
LastUpdateLogin: string
Read Only:
true
Maximum Length:32
Session login associated with the user who last updated the row. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
NeedByDate: string
(date-time)
Date when the part is required.
-
ParentEntityCode: string
Maximum Length:
30
Abbreviation that identifies the parent entity of the parts requirement header. A list of accepted codes is defined in the lookup type ORA_RCL_SOURCE_DOC_TYPE. -
ParentEntityCodeMeaning: string
Read Only:
true
Maximum Length:80
Meaning of the parent entity code. -
ParentEntityId: integer
(int64)
Value that uniquely identifies the parent entity of the parts requirement header.
-
ParentEntityNumber: string
Maximum Length:
30
Number that identifies the parent document associated with the service logistics parts requirement . -
partRequirementHeadersDFF: array
Flexfields for Part Requirement Headers
Title:
Flexfields for Part Requirement Headers
Data used to manage the flexfields for a part requirement header. -
PurchaseOrder: string
Maximum Length:
50
Value that defines the purchase order number from the service request for the parts requirement header. -
RequirementHeaderId: integer
(int64)
Value that uniquely identifies the part requirement header.
-
ShipToAddress: string
Read Only:
true
Maximum Length:4000
Value that identifies the ship-to address. -
ShipToAddressType: string
Maximum Length:
30
Type of address that the requirement will be shipped to. Values are Customer, Technician, and Warehouse. -
ShipToAddressTypeMeaning: string
Read Only:
true
Maximum Length:80
Meaning of the ship-to address type. -
ShipToPartyId: integer
(int64)
Value that uniquely identifies the ship-to customer party.
-
ShipToPartyName: string
Read Only:
true
Maximum Length:360
Name of the ship-to party. -
ShipToPartySiteId: integer
(int64)
Value that uniquely identifies the ship-to party site address.
-
SoldToPartyId: integer
(int64)
Value that uniquely identifies the sold-to customer party.
-
SoldToPartyName: string
Read Only:
true
Maximum Length:360
Name of the sold-to party. -
TechnicianPartyId: integer
(int64)
Value that uniquely identifies the technician.
-
TechnicianPartyName: string
Read Only:
true
Maximum Length:360
Name of the technician. -
TechnicianPartyNumber: string
Read Only:
true
Maximum Length:30
Number that identifies the technician.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Nested Schema : Flexfields for Part Requirement Headers
Type:
array
Title:
Flexfields for Part Requirement Headers
Data used to manage the flexfields for a part requirement header.
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 : partRequirementHeaders-partRequirementHeadersDFF-item-response
Type:
Show Source
object
-
__FLEX_Context: string
Title:
Context Segment
Maximum Length:30
Descriptive flexfield context name for requirement headers. -
__FLEX_Context_DisplayValue: string
Title:
Context Segment
Descriptive flexfield context display value for requirement headers. -
links: array
Links
Title:
Links
The link relations associated with the resource instance. -
RequirementHeaderId: integer
(int64)
Value that uniquely identifies the requirement header.
Nested Schema : Links
Type:
array
Title:
Links
The link relations associated with the resource instance.
Show Source
Links
- partRequirementHeadersDFF
-
Parameters:
- RequirementHeaderId:
$request.path.RequirementHeaderId
Data used to manage the flexfields for a part requirement header. - RequirementHeaderId: