Jump to

• Request
• Response

Get all action requests

get

/fscmRestApi/resources/11.13.18.05/omSearchMassActionRequests

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:
  
  

  • ActionFinder: Finds an action request by an action finder.
    Finder Variables:
    • ActionCode; string; Action code of the action.
    • CreatedBy; string; User who created the action request.
    • CreationDateFrom; string; From Date of the date range within which the action request is created.
    • CreationDateTo; string; To Date of the date range within which the action request is created.
    • CustomerPONumber; string; Customer purchase order number.
    • Keyword; string; Keywords for the search of an action request.
    • OrderNumber; string; Identifer of the sales order number.
    • ProcessId; string; Unique identifier for the process.
    • ProcessStatus; string; Status of the process initiated by the action request to process the action.
    • SoldToPartyId; string; Unique identifier of the sold-to party.
    • SourceOrderNumber; string; Unique identifier for the sales order in the source system.
  • PrimaryKey: Finds an action request by the primary key.
    Finder Variables:
    • ActionRequestId; integer; Unique identifier for the action request.
• 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:
  

  • ActionCode; string; Code such as ORA_FOM_SUBMIT_ORDER to identify the action.
  • ActionName; string; Value attribute for the action such as Submit Order, Cancel Order, Reprice Order, or Cancel Line.
  • ActionRequestId; integer; Unique identifier for the master action request.
  • ActionRequestTrackingId; integer; Identifier to track an action request.
  • CreatedBy; string; User who created the action request.
  • CreationDate; string; Date on which the action request is created.
  • FilterCriteria; string; Contains the filter criterion for the sales orders or sales order lines submitted for the Select All action. This criterion is used to get the sales order numbers or sales order line numbers as the application doesn't send specific sales order numbers or sales order line numbers.
  • LastUpdateDate; string; Date on which action request was last updated.
  • MassActionFlag; boolean; Indicates that the action is a mass action.
  • OutcomeCode; string; Code to indicate the outcome of the master action request. It can be SUCCESS or ERROR.
  • ProcessId; number; Unique identifier for the process to initiate the process in the request resource.
  • ProcessStatus; string; Status of the process initiated by the action request to process the action such as COMPLETED, IN_QUEUE, IN_PROGRESS, or COMPLETED_WITH_ERRORS.
  • StatusCode; string; Code to indicate the status of the master action request such as COMPLETE, PRE_PROCESSING, or PROCESSING.
  • TotalFailed; number; Total number of records that the action failed to process.
  • TotalPassed; number; Total number of records successfully processed by the action.
  • TotalRecords; number; Total number of records processed by the action request.
• 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 : omSearchMassActionRequests

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/omSearchMassActionRequests-item-response"
            }
        }
    },
    "x-hints":{
        "subgroup":"OrderManagement",
        "usage":"BusinessObject",
        "group":"SCM"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object omSearchMassActionRequests-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/omSearchMassActionRequests-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 : omSearchMassActionRequests-item-response

Type: object

Show Source

• ActionCode: string
  Read Only: true

  Maximum Length: 255

  Code such as ORA_FOM_SUBMIT_ORDER to identify the action.
• ActionName: string
  Read Only: true

  Maximum Length: 80

  Value attribute for the action such as Submit Order, Cancel Order, Reprice Order, or Cancel Line.
• ActionRequestId: integer (int64)
  Read Only: true

  Unique identifier for the master action request.
• ActionRequestTrackingId: integer (int64)
  Read Only: true

  Identifier to track an action request.
• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the action request.
• CreationDate: string (date-time)
  Read Only: true

  Date on which the action request is created.
• FilterCriteria: string
  Read Only: true

  Maximum Length: 255

  Contains the filter criterion for the sales orders or sales order lines submitted for the Select All action. This criterion is used to get the sales order numbers or sales order line numbers as the application doesn't send specific sales order numbers or sales order line numbers.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date on which action request was last updated.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• MassActionFlag: boolean
  Read Only: true

  Maximum Length: 1

  Indicates that the action is a mass action.
• OutcomeCode: string
  Read Only: true

  Maximum Length: 30

  Code to indicate the outcome of the master action request. It can be SUCCESS or ERROR.
• ProcessId: number
  Read Only: true

  Unique identifier for the process to initiate the process in the request resource.
• ProcessStatus: string
  Read Only: true

  Maximum Length: 30

  Status of the process initiated by the action request to process the action such as COMPLETED, IN_QUEUE, IN_PROGRESS, or COMPLETED_WITH_ERRORS.
• StatusCode: string
  Read Only: true

  Maximum Length: 30

  Code to indicate the status of the master action request such as COMPLETE, PRE_PROCESSING, or PROCESSING.
• TotalFailed: number
  Read Only: true

  Total number of records that the action failed to process.
• TotalPassed: number
  Read Only: true

  Total number of records successfully processed by the action.
• TotalRecords: number
  Read Only: true

  Total number of records processed by the action request.

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "type":"string",
            "description":"Date on which the action request is created.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OutcomeCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code to indicate the outcome of the master action request. It can be SUCCESS or ERROR.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":"64",
            "type":"string",
            "description":"User who created the action request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcessStatus":{
            "maxLength":"30",
            "type":"string",
            "description":"Status of the process initiated by the action request to process the action such as COMPLETED, IN_QUEUE, IN_PROGRESS, or COMPLETED_WITH_ERRORS.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "MassActionFlag":{
            "maxLength":"1",
            "type":"boolean",
            "description":"Indicates that the action is a mass action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionCode":{
            "maxLength":"255",
            "type":"string",
            "description":"Code such as ORA_FOM_SUBMIT_ORDER to identify the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionRequestId":{
            "type":"integer",
            "description":"Unique identifier for the master action request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "FilterCriteria":{
            "maxLength":"255",
            "type":"string",
            "description":"Contains the filter criterion for the sales orders or sales order lines submitted for the Select All action. This criterion is used to get the sales order numbers or sales order line numbers as the application doesn't send specific sales order numbers or sales order line numbers.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "StatusCode":{
            "maxLength":"30",
            "type":"string",
            "description":"Code to indicate the status of the master action request such as COMPLETE, PRE_PROCESSING, or PROCESSING.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ActionRequestTrackingId":{
            "type":"integer",
            "description":"Identifier to track an action request.",
            "format":"int64",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "precision":"18"
            },
            "x-queryable":true
        },
        "ActionName":{
            "maxLength":"80",
            "type":"string",
            "description":"Value attribute for the action such as Submit Order, Cancel Order, Reprice Order, or Cancel Line.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalFailed":{
            "type":"number",
            "description":"Total number of records that the action failed to process.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalRecords":{
            "type":"number",
            "description":"Total number of records processed by the action request.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ProcessId":{
            "type":"number",
            "description":"Unique identifier for the process to initiate the process in the request resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "TotalPassed":{
            "type":"number",
            "description":"Total number of records successfully processed by the action.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date on which action request was last updated.",
            "format":"date-time",
            "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