Jump to

• Request
• Response

Get all job details

get

/fscmRestApi/resources/11.13.18.05/erpintegrations

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:
  
  

  • DocumentIdsByFilePrefixRF: Finds all the document IDs of documents that match the specified file prefix and document account, excluding the documents with specified comments.
    Finder Variables:
    • comment; string; Comment for the documents in UCM.
    • docAccount; string; The document account in UCM.
    • filePrefix; string; The file prefix for the documents in UCM.
  • DocumentRF: Finds all the document content for the specified document ID.
    Finder Variables:
    • docId; string; The unique identifier for any document in UCM.
  • 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.
  • 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.
  • 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.
  • 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.
• 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:
  

  • CallbackURL; string; The callback URL of the service implemented by a customer to receive the job status of an Enterprise Scheduling Service job upon its completion.
  • Comments; string; The action that appends the specified comments to a file.
  • ContentType; string; The type of content within a data file to be processed by the ERP Integration Service.
  • DocumentAccount; string; The account parameter to search for files corresponding to a specified security account.
  • DocumentContent; string; The content of the file in Base64 encoded format.
  • DocumentId; string; The unique identifier of a file associated with the row.
  • ESSParameters; string; 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.
  • FileName; string; The name of the data file to be processed by the ERP Integration Service.
  • FileType; string; 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.
  • JobDefName; string; The name of the Enterprise Scheduling Service job definition that must be submitted.
  • JobName; string; The job name and job package name separated by a comma.
  • JobOptions; string; 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.
  • JobPackageName; string; The name of the Enterprise Scheduling Service job package that must be submitted.
  • LoadRequestId; string; The unique identifier of the load process that populates data in a product interface table.
  • NotificationCode; string; The two-digit code that determines the notification type and when the notification should be sent. Currently the bell and email notifications are supported only for loadAndImportData, ImportBulkData, ExportBulkData, and extractAndPurge operations.
  • OperationName; string; The name of the ERP Integration Service operations used to manage inbound and outbound data flows.
  • ParameterList; string; 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.
  • ProcessName; string; The name of a particular business application's data import process.
  • ReqstId; string; The unique identifier of the submitted Enterprise Scheduling Service job request.
  • RequestStatus; string; The current status of the Enterprise Scheduling Service job.
  • StatusCode; string; The code representing the current status of the Enterprise Scheduling Service job.
• 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(required):
  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(required):
  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 : erpintegrations

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/erpintegrations-item-response"
            }
        }
    },
    "x-hints":{
        "usage":"BusinessObject"
    }
}

Nested Schema : Items

Type: array

Title: Items

The items in the collection.

Show Source

• Array of: object erpintegrations-item-response

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

Type: object

Show Source

• CallbackURL: string
  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.
• Comments: string
  Title: Comments

  The action that appends the specified comments to a file.
• ContentType: string
  Title: Content Type

  The type of content within a data file to be processed by the ERP Integration Service.
• DocumentAccount: string
  Title: Document Account

  The account parameter to search for files corresponding to a specified security account.
• DocumentContent: string
  Title: Document Content

  The content of the file in Base64 encoded format.
• DocumentId: string
  Title: Document Identifier

  The unique identifier of a file associated with the row.
• ESSParameters: string
  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.
• FileName: string
  Title: File Name

  The name of the data file to be processed by the ERP Integration Service.
• FileType: string
  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.
• JobDefName: string
  Title: Job Definition Name

  The name of the Enterprise Scheduling Service job definition that must be submitted.
• JobName: string
  Title: Job Name

  The job name and job package name separated by a comma.
• JobOptions: string
  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.
• JobPackageName: string
  Title: Job Package Name

  The name of the Enterprise Scheduling Service job package that must be submitted.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• LoadRequestId: string
  Title: Load Request Identifier

  The unique identifier of the load process that populates data in a product interface table.
• NotificationCode: string
  Title: Notification Code

  The two-digit code that determines the notification type and when the notification should be sent. Currently the bell and email notifications are supported only for loadAndImportData, ImportBulkData, ExportBulkData, and extractAndPurge operations.
• OperationName: string
  Title: Operation Name

  The name of the ERP Integration Service operations used to manage inbound and outbound data flows.
• ParameterList: string
  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.
• ProcessName: string
  Title: Process Name

  The name of a particular business application's data import process.
• ReqstId: string
  Title: Request Identifier

  The unique identifier of the submitted Enterprise Scheduling Service job request.
• RequestStatus: string
  Title: Request Status

  The current status of the Enterprise Scheduling Service job.
• StatusCode: string
  Title: Status Code

  The code representing the current status of the Enterprise Scheduling Service job.

{
    "type":"object",
    "properties":{
        "ProcessName":{
            "title":"Process Name",
            "type":"string",
            "description":"The name of a particular business application's data import process.",
            "nullable":true,
            "x-queryable":true
        },
        "ContentType":{
            "title":"Content Type",
            "type":"string",
            "description":"The type of content within a data file to be processed by the ERP Integration Service.",
            "nullable":true,
            "x-queryable":true
        },
        "OperationName":{
            "title":"Operation Name",
            "type":"string",
            "description":"The name of the ERP Integration Service operations used to manage inbound and outbound data flows.",
            "nullable":true,
            "x-queryable":true
        },
        "Comments":{
            "title":"Comments",
            "type":"string",
            "description":"The action that appends the specified comments to a file.",
            "nullable":true,
            "x-queryable":true
        },
        "FileName":{
            "title":"File Name",
            "type":"string",
            "description":"The name of the data file to be processed by the ERP Integration Service.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentId":{
            "title":"Document Identifier",
            "type":"string",
            "description":"The unique identifier of a file associated with the row.",
            "nullable":true,
            "x-queryable":true
        },
        "JobName":{
            "title":"Job Name",
            "type":"string",
            "description":"The job name and job package name separated by a comma.",
            "nullable":true,
            "x-queryable":true
        },
        "StatusCode":{
            "title":"Status Code",
            "type":"string",
            "description":"The code representing the current status of the Enterprise Scheduling Service job.",
            "nullable":true,
            "x-queryable":true
        },
        "JobDefName":{
            "title":"Job Definition Name",
            "type":"string",
            "description":"The name of the Enterprise Scheduling Service job definition that must be submitted.",
            "nullable":true,
            "x-queryable":true
        },
        "CallbackURL":{
            "title":"Callback URL",
            "type":"string",
            "description":"The callback URL of the service implemented by a customer to receive the job status of an Enterprise Scheduling Service job upon its completion.",
            "nullable":true,
            "x-queryable":true
        },
        "NotificationCode":{
            "title":"Notification Code",
            "type":"string",
            "description":"The two-digit code that determines the notification type and when the notification should be sent. Currently the bell and email notifications are supported only for loadAndImportData, ImportBulkData, ExportBulkData, and extractAndPurge operations.",
            "nullable":true,
            "x-queryable":true
        },
        "FileType":{
            "title":"File Type",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "JobPackageName":{
            "title":"Job Package Name",
            "type":"string",
            "description":"The name of the Enterprise Scheduling Service job package that must be submitted.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentContent":{
            "title":"Document Content",
            "type":"string",
            "description":"The content of the file in Base64 encoded format.",
            "nullable":true,
            "x-queryable":true
        },
        "DocumentAccount":{
            "title":"Document Account",
            "type":"string",
            "description":"The account parameter to search for files corresponding to a specified security account.",
            "nullable":true,
            "x-queryable":true
        },
        "LoadRequestId":{
            "title":"Load Request Identifier",
            "type":"string",
            "description":"The unique identifier of the load process that populates data in a product interface table.",
            "nullable":true,
            "x-queryable":true
        },
        "ESSParameters":{
            "title":"Parameters",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "JobOptions":{
            "title":"Job Options",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "ParameterList":{
            "title":"Parameter List",
            "type":"string",
            "description":"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.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ReqstId":{
            "title":"Request Identifier",
            "type":"string",
            "description":"The unique identifier of the submitted Enterprise Scheduling Service job request.",
            "nullable":true,
            "x-queryable":true
        },
        "RequestStatus":{
            "title":"Request Status",
            "type":"string",
            "description":"The current status of the Enterprise Scheduling Service job.",
            "nullable":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