Jump to

• Request
• Response

Get all requirement headers

get

/fscmRestApi/resources/11.13.18.05/partRequirementHeaders

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 part requirement headers according to the specified primary key criteria.
    Finder Variables:
    • RequirementHeaderId; integer; Value that uniquely identifies the requirement header.
• 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:
  

  • BUName; string; Name of the business unit.
  • BUOrgId; integer; Value that uniquely identifies the business unit.
  • BillToAccountId; integer; Value that uniquely identifies the bill-to customer account.
  • BillToAccountNumber; string; Number that identifies the bill-to customer account.
  • BillToAddress; string; Billing address of the customer.
  • BillToPartyId; integer; Value that uniquely identifies the bill-to customer party.
  • BillToPartyName; string; Name of the bill-to customer party.
  • BillToPartySiteId; integer; Value that uniquely identifies the bill-to party site address.
  • CreatedBy; string; User who created the row.
  • CreationDate; string; Date and time the row was created.
  • DestinationOrganizationId; integer; Value that uniquely identifies the destination organization.
  • DestinationOrganizationName; string; Name of the destination organization.
  • DestinationSubinventory; string; Name of the destination subinventory.
  • LastUpdateDate; string; Date and time of the last update of the row.
  • LastUpdateLogin; string; Session login associated with the user who last updated the row.
  • LastUpdatedBy; string; User who last updated the row.
  • NeedByDate; string; Date when the part is required.
  • ParentEntityCode; string; 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; Meaning of the parent entity code.
  • ParentEntityId; integer; Value that uniquely identifies the parent entity of the parts requirement header.
  • ParentEntityNumber; string; Number that identifies the parent document associated with the service logistics parts requirement .
  • PurchaseOrder; string; Value that defines the purchase order number from the service request for the parts requirement header.
  • RequirementHeaderId; integer; Value that uniquely identifies the part requirement header.
  • ShipToAddress; string; Value that identifies the ship-to address.
  • ShipToAddressType; string; Type of address that the requirement will be shipped to. Values are Customer, Technician, and Warehouse.
  • ShipToAddressTypeMeaning; string; Meaning of the ship-to address type.
  • ShipToPartyId; integer; Value that uniquely identifies the ship-to customer party.
  • ShipToPartyName; string; Name of the ship-to party.
  • ShipToPartySiteId; integer; Value that uniquely identifies the ship-to party site address.
  • SoldToPartyId; integer; Value that uniquely identifies the sold-to customer party.
  • SoldToPartyName; string; Name of the sold-to party.
  • TechnicianPartyId; integer; Value that uniquely identifies the technician.
  • TechnicianPartyName; string; Name of the technician.
  • TechnicianPartyNumber; string; Number that identifies the technician.
• 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:
  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 : partRequirementHeaders

Type: object

Show Source

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

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"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."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/partRequirementHeaders-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"Maintenance",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object partRequirementHeaders-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/partRequirementHeaders-item-response"
    }
}

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 : partRequirementHeaders-item-response

Type: object

Show Source

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

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date and time the row was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToAddress":{
            "maxLength":"4000",
            "type":"string",
            "description":"Value that identifies the ship-to address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RequirementHeaderId":{
            "type":"integer",
            "description":"Value that uniquely identifies the part requirement header.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "DestinationOrganizationId":{
            "type":"integer",
            "description":"Value that uniquely identifies the destination organization.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "TechnicianPartyNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the technician.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationOrganizationName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the destination organization.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentEntityCodeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the parent entity code.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ParentEntityNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the parent document associated with the service logistics parts requirement .",
            "nullable":false,
            "x-queryable":true
        },
        "ShipToPartyName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the ship-to party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to customer party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillToAccountNumber":{
            "maxLength":"30",
            "type":"string",
            "description":"Number that identifies the bill-to customer account.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BUName":{
            "maxLength":"240",
            "type":"string",
            "description":"Name of the business unit.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TechnicianPartyName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the technician.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToAddress":{
            "maxLength":"4000",
            "type":"string",
            "description":"Billing address of the customer.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DestinationOrganizationCode":{
            "maxLength":"80",
            "type":"string",
            "description":"Abbreviation that identifies the destination organization.",
            "nullable":true,
            "x-queryable":false
        },
        "ParentEntityCode":{
            "maxLength":"30",
            "type":"string",
            "description":"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.",
            "nullable":false,
            "x-queryable":true
        },
        "SoldToPartyName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the sold-to party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to customer party.",
            "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"
            }
        },
        "LastUpdatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TechnicianPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the technician.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ParentEntityId":{
            "type":"integer",
            "description":"Value that uniquely identifies the parent entity of the parts requirement header.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "BillToPartySiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to party site address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipToAddressType":{
            "maxLength":"30",
            "type":"string",
            "description":"Type of address that the requirement will be shipped to. Values are Customer, Technician, and Warehouse.",
            "nullable":true,
            "x-queryable":true
        },
        "DestinationSubinventory":{
            "maxLength":"10",
            "type":"string",
            "description":"Name of the destination subinventory.",
            "nullable":true,
            "x-queryable":true
        },
        "SoldToPartyId":{
            "type":"integer",
            "description":"Value that uniquely identifies the sold-to customer party.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BillToPartyName":{
            "maxLength":"360",
            "type":"string",
            "description":"Name of the bill-to customer party.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ShipToPartySiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the ship-to party site address.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ShipToAddressTypeMeaning":{
            "maxLength":"80",
            "type":"string",
            "description":"Meaning of the ship-to address type.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "NeedByDate":{
            "type":"string",
            "description":"Date when the part is required.",
            "format":"date-time",
            "nullable":true,
            "x-queryable":true
        },
        "BillToAccountId":{
            "type":"integer",
            "description":"Value that uniquely identifies the bill-to customer account.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "BUOrgId":{
            "type":"integer",
            "description":"Value that uniquely identifies the business unit.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "PurchaseOrder":{
            "maxLength":"50",
            "type":"string",
            "description":"Value that defines the purchase order number from the service request for the parts requirement header.",
            "nullable":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"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":"Session login associated with the user who last updated the row.",
            "nullable":true,
            "readOnly":true,
            "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."
        }
    }
}

Back to Top