Get all job details

get

/fscmRestApi/resources/11.13.18.05/erpintegrations

Request

Query Parameters
  • This parameter specifies dependencies which are attributes that are set before and rolled back after generating the response. Generally they are used to preview the effects of an attribute change. The attributes 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 attributes 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 attributes. Example: dependency=ProductId=2

    Format: <attr1>=<val1>,<attr2>=<value2>
  • 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).
  • This parameter filters the resource attributes. Only the specified attributes are returned, which means that if no attributes are specified, no attributes 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 attributes. 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
  • 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:

    • ESSJobStatusRF: Finds the status of the Enterprise Scheduling Service job for the specified request ID. Finder Variables:
      • requestId; string; The unique identifier of the status of an Enterprise Scheduling Service job.
    • ESSExecutionDetailsRF: Finds the execution details pf the Enterprise Scheduling Service job for the specified request ID. Finder Variables:
      • jobOptions; string; The parameters provided for operation in future use.
      • requestId; string; The unique identifier of an Enterprise Scheduling Service job.
    • DocumentRF: Finds all the document content for the specified document ID. Finder Variables:
      • docId; string; The unique identifier for any document in UCM.
    • ESSJobExecutionDetailsRF: Finds all the Enterprise Scheduling Service job execution details for the specified request ID and file type. Finder Variables:
      • fileType; string; The file type associated with the job execution details.
      • requestId; string; The unique identifier of an Enterprise Scheduling Service job.
    • PrimaryKey: Finds the ERP interface options for the specified operation name. Finder Variables:
      • OperationName; string; The name of the web service operation that is executed.
  • 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.
  • 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.
  • The resource item payload will be filtered in order to contain only data (no links section, for example).
  • This parameter orders a resource collection based on the specified attributes. 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
  • 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
  • The resource collection representation will include the "estimated row count" when "?totalResults=true", otherwise the count is not included. The default value is "false".
Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : erpintegrations
Type: object
Show Source
Nested Schema : Items
Type: array
Title: Items
The items in the collection.
Show Source
Nested Schema : erpintegrations-item
Type: object
Show Source
  • Title: Callback URL
    The callback URL of the service implemented by a customer to receive the job status of an Enterprise Scheduling Service job upon its completion.
  • Title: Comments
    The action that appends the specified comments to a file.
  • Title: Content Type
    The type of content within a data file to be processed by the ERP Integration Service.
  • Title: Document Account
    The account parameter to search for files corresponding to a specified security account.
  • Title: Document Content
    The content of the file in Base64 encoded format.
  • Title: Document Identifier
    The unique identifier of a file associated with the row.
  • Title: Parameters
    The list of parameters used to run the Enterprise Scheduling Service job. The list determines the order of the parameters. The corresponding entry in the list should be blank when a given parameter is not passed.
  • Title: File Name
    The name of the data file to be processed by the ERP Integration Service.
  • Title: File Type
    The file type that determines the execution details to be downloaded. Specify LOG as the file type to download the log and output file. Specify OUT as the file type to download only the output file. If no file type is specified, both the log files and output files are downloaded.
  • Title: Job Definition Name
    The name of the Enterprise Scheduling Service job definition that must be submitted.
  • Title: Job Name
    The job name and job package name separated by a comma.
  • Title: Job Options
    A web service operation input parameter. It specifies the inbound bulk data processing variation and the output file type that is generated when the data is processed.
  • Title: Job Package Name
    The name of the Enterprise Scheduling Service job package that must be submitted.
  • Items
  • Title: Load Request Identifier
    The unique identifier of the load process that populates data in a product interface table.
  • Title: Notification Code
    The two-digit code that determines the notification type and when the notification should be sent.
  • Title: Operation Name
    The name of the ERP Integration Service operations used to manage inbound and outbound data flows.
  • Title: Parameter List
    The list of parameters used to run the Enterprise Scheduling Service job. The list determines the order of the parameters. The corresponding entry in the list must be blank when a given parameter is not passed.
  • Title: Process Name
    The name of a particular business application's data import process.
  • Title: Request Identifier
    The unique identifier of the submitted Enterprise Scheduling Service job request.
  • Title: Request Status
    The current status of the Enterprise Scheduling Service job.
  • Title: Status Code
    The code representing the current status of the Enterprise Scheduling Service job.
Back to Top