REST API for Oracle Fusion Cloud SCM (2024)

• HeaderId(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=

• LineId(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=

• 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

• 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 the serial number based on the primary key.
    Finder Variables
    • SerialId; integer; Value that uniquely identifies the recalled serial number.
• 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

  See Also

  What is the recall on the Ford Taurus fuel pump module? | AHG Auto ServiceToyota Recall Checker | Owners | Toyota UK

  You can use these queryable attributes to filter this collection resource using the q query parameter:

  • CreatedBy; string; User who created the record.
  • CreationDate; string; Date and time when the user created the record.
  • HeaderId; integer; Value that uniquely identifies the recall notice header.
  • LastUpdateDate; string; Date and time when the user most recently updated the record.
  • LastUpdateLogin; string; User who most recently updated the record.
  • LastUpdatedBy; string; Name of the user who most recently updated the record.
  • LineId; integer; Value that uniquely identifies the recall notice line.
  • LineNumber; integer; Number that identifies the recall notice line entered by the user.
  • LotId; integer; Value that uniquely identifies the recalled lot.
  • MfgFromSerialNumber; string; Starting serial number as specified by the manufacturer in the recall notice.
  • MfgToSerialNumber; string; Ending serial number as specified by the manufacturer in the recall notice.
  • ObjectVersionNumber; integer; Number that identifies the object version. This attribute is used to implement optimistic locking. The number is incremented every time the record is updated. The number is compared at the start and at the end of a transaction to detect whether another session has updated the record since it was queried.
  • Quantity; number; Quantity of the recalled serial number. This is an optional value that's used to calculate ToSerialNumber when the quantity is added to From Serial Number.
  • SerialEntryMode; string; Mode whether to enter an individual serial or a serial in a range.
  • SerialId; integer; Value that uniquely identifies the recalled serial number.
• 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".

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

Default Response