Get an export process result

get

/fscmRestApi/resources/11.13.18.05/setupOfferingCSVExports/{OfferingCode}/child/SetupOfferingCSVExportProcess/{ProcessId}/child/SetupOfferingCSVExportProcessResult/{ProcessId}

Get an export process result

Request

Path Parameters
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
  • 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
  • The resource item payload will be filtered in order to contain only data (no links section, for example).

There's no request body for this operation.

Back to Top

Response

Supported Media Types

Default Response

The following table describes the default response for this task.
Body ()
Root Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-SetupOfferingCSVExportProcessResult-item-response
Match All
Show Source
Nested Schema : ItemProperties
Type: object
Show Source
Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-SetupOfferingCSVExportProcessResult-item
Type: object
Show Source
  • Title: CSV Template Report
    Read Only: true
    Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
    The packaged file containing the CSV template report files.
  • Title: File Content
    Read Only: true
    Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
    The .zip file containing the setup offering CSV files.
  • Title: File Name
    The name of the packaged file containing the setup offering
  • Title: Process ID
    The unique identifier of the export process result.
  • Title: Process Log
    Read Only: true
    Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
    The log containing the processing details of each business object.
  • Title: Process Name
    Name of the export process.
  • Title: Process Results Report
    Read Only: true
    Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
    The report that contains the results for each business object of the offering or functional area included in the export process.
  • Title: Process Results Summary Report
    Read Only: true
    Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$
    The summary report for the export process.
  • Title: Status Code
    The status of the export process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.
Back to Top