Jump to

• Request
• Response
• Examples

Create a setup offering CSV template export

post

/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports

Create a setup offering CSV template export

Request

There are no request parameters for this operation.

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Request Body - application/json ()

Root Schema : schema

Match All

Show Source

• object setupOfferingCSVTemplateExports-item
• object type

{ "allOf":[ { "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-item" }, { "type":"object", "properties":{ "SetupOfferingCSVTemplateExportProcess":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request" } } } } ] }

Nested Schema : setupOfferingCSVTemplateExports-item

Type: object

Show Source

• FunctionalAreaCode: string
  Title: Functional Area Code

  The unique code of the setup functional area. This attribute is required when exporting setup offering CSV template for a functional area.
• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering. This attribute is required when exporting setup offering CSV template for an offering.

{ "type":"object", "properties":{ "OfferingCode":{ "title":"Offering Code", "type":"string", "description":"The unique code of the setup offering. This attribute is required when exporting setup offering CSV template for an offering.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "FunctionalAreaCode":{ "title":"Functional Area Code", "type":"string", "description":"The unique code of the setup functional area. This attribute is required when exporting setup offering CSV template for a functional area.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } } } }

Nested Schema : type

Type: object

Show Source

• SetupOfferingCSVTemplateExportProcess: array SetupOfferingCSVTemplateExportProcess

{ "type":"object", "properties":{ "SetupOfferingCSVTemplateExportProcess":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request" } } } }

Nested Schema : SetupOfferingCSVTemplateExportProcess

Type: array

Show Source

• Array of: setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request

{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request" } }

Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request

Match All

Show Source

• object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item
• object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request-allOf[1]

{ "allOf":[ { "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item" }, { "type":"object", "properties":{ "SetupOfferingCSVTemplateExportProcessResult":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-request" } } } } ] }

Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item

Type: object

Show Source

• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering for which the CSV template is generated.
• ProcessCompletedFlag: string
  Title: Process Complete

  Indicates whether the export process is complete. This attribute does not have a default value.
• ProcessId: integer (int32)
  Title: Process ID

  The unique identifier of the setup offering CSV template export process.

{ "type":"object", "properties":{ "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the setup offering CSV template export process.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "OfferingCode":{ "title":"Offering Code", "type":"string", "description":"The unique code of the setup offering for which the CSV template is generated.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessCompletedFlag":{ "title":"Process Complete", "type":"string", "description":"Indicates whether the export process is complete. This attribute does not have a default value.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true, "adf-properties":{ "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet" } } } } }

Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request-allOf[1]

Type: object

Show Source

• SetupOfferingCSVTemplateExportProcessResult: array SetupOfferingCSVTemplateExportProcessResult

{ "type":"object", "properties":{ "SetupOfferingCSVTemplateExportProcessResult":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-request" } } } }

Nested Schema : SetupOfferingCSVTemplateExportProcessResult

Type: array

Show Source

• Array of: object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item

{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-request" } }

Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item

Type: object

Show Source

• CSVTemplateReport: string (byte)
  Title: CSV Template Report

  Read Only: true

  Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

  The .zip file containing the template report files for the setup offering CSV template.
• FileContent: string (byte)
  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 template files.
• FileName: string
  Title: File Name

  The name of the .zip file containing the setup offering CSV template files.
• ProcessId: integer (int32)
  Title: Process ID

  The unique identifier of the setup offering CSV template export process result.
• ProcessLog: string (byte)
  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 in the setup offering CSV template export process.
• ProcessName: string
  Title: Process Name

  Name of the setup offering CSV template export process.
• ProcessResultsReport: string (byte)
  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 CSV template export process.
• ProcessResultsSummaryReport: string (byte)
  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 setup offering CSV template export process.
• StatusCode: string
  Title: Status Code

  The status of the export process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.

{ "type":"object", "properties":{ "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the setup offering CSV template export process result.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessName":{ "title":"Process Name", "type":"string", "description":"Name of the setup offering CSV template export process.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "StatusCode":{ "title":"Status Code", "type":"string", "description":"The status of the export process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "FileName":{ "title":"File Name", "type":"string", "description":"The name of the .zip file containing the setup offering CSV template files.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "FileContent":{ "title":"File Content", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The .zip file containing the setup offering CSV template files.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessLog":{ "title":"Process Log", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The log containing the processing details of each business object in the setup offering CSV template export process.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "CSVTemplateReport":{ "title":"CSV Template Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The .zip file containing the template report files for the setup offering CSV template.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessResultsReport":{ "title":"Process Results Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The report that contains the results for each business object of the offering or functional area included in the CSV template export process.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessResultsSummaryReport":{ "title":"Process Results Summary Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The summary report for the setup offering CSV template export process.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } } } }

Request Body - application/vnd.oracle.adf.resourceitem+json ()

Root Schema : schema

Match All

Show Source

• object setupOfferingCSVTemplateExports-item
• object type

{ "allOf":[ { "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-item" }, { "type":"object", "properties":{ "SetupOfferingCSVTemplateExportProcess":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request" } } } } ] }

Nested Schema : setupOfferingCSVTemplateExports-item

Type: object

Show Source

• FunctionalAreaCode: string
  Title: Functional Area Code

  The unique code of the setup functional area. This attribute is required when exporting setup offering CSV template for a functional area.
• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering. This attribute is required when exporting setup offering CSV template for an offering.

{ "type":"object", "properties":{ "OfferingCode":{ "title":"Offering Code", "type":"string", "description":"The unique code of the setup offering. This attribute is required when exporting setup offering CSV template for an offering.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "FunctionalAreaCode":{ "title":"Functional Area Code", "type":"string", "description":"The unique code of the setup functional area. This attribute is required when exporting setup offering CSV template for a functional area.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } } } }

Nested Schema : type

Type: object

Show Source

• SetupOfferingCSVTemplateExportProcess: array SetupOfferingCSVTemplateExportProcess

{ "type":"object", "properties":{ "SetupOfferingCSVTemplateExportProcess":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request" } } } }

Nested Schema : SetupOfferingCSVTemplateExportProcess

Type: array

Show Source

• Array of: setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request

{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request" } }

Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request

Match All

Show Source

• object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item
• object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request-allOf[1]

{ "allOf":[ { "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item" }, { "type":"object", "properties":{ "SetupOfferingCSVTemplateExportProcessResult":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-request" } } } } ] }

Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item

Type: object

Show Source

• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering for which the CSV template is generated.
• ProcessCompletedFlag: string
  Title: Process Complete

  Indicates whether the export process is complete. This attribute does not have a default value.
• ProcessId: integer (int32)
  Title: Process ID

  The unique identifier of the setup offering CSV template export process.

{ "type":"object", "properties":{ "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the setup offering CSV template export process.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "OfferingCode":{ "title":"Offering Code", "type":"string", "description":"The unique code of the setup offering for which the CSV template is generated.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessCompletedFlag":{ "title":"Process Complete", "type":"string", "description":"Indicates whether the export process is complete. This attribute does not have a default value.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true, "adf-properties":{ "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet" } } } } }

Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-request-allOf[1]

Type: object

Show Source

• SetupOfferingCSVTemplateExportProcessResult: array SetupOfferingCSVTemplateExportProcessResult

{ "type":"object", "properties":{ "SetupOfferingCSVTemplateExportProcessResult":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-request" } } } }

Nested Schema : SetupOfferingCSVTemplateExportProcessResult

Type: array

Show Source

• Array of: object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item

{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-request" } }

Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item

Type: object

Show Source

• CSVTemplateReport: string (byte)
  Title: CSV Template Report

  Read Only: true

  Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

  The .zip file containing the template report files for the setup offering CSV template.
• FileContent: string (byte)
  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 template files.
• FileName: string
  Title: File Name

  The name of the .zip file containing the setup offering CSV template files.
• ProcessId: integer (int32)
  Title: Process ID

  The unique identifier of the setup offering CSV template export process result.
• ProcessLog: string (byte)
  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 in the setup offering CSV template export process.
• ProcessName: string
  Title: Process Name

  Name of the setup offering CSV template export process.
• ProcessResultsReport: string (byte)
  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 CSV template export process.
• ProcessResultsSummaryReport: string (byte)
  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 setup offering CSV template export process.
• StatusCode: string
  Title: Status Code

  The status of the export process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.

{ "type":"object", "properties":{ "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the setup offering CSV template export process result.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessName":{ "title":"Process Name", "type":"string", "description":"Name of the setup offering CSV template export process.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "StatusCode":{ "title":"Status Code", "type":"string", "description":"The status of the export process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "FileName":{ "title":"File Name", "type":"string", "description":"The name of the .zip file containing the setup offering CSV template files.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "FileContent":{ "title":"File Content", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The .zip file containing the setup offering CSV template files.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessLog":{ "title":"Process Log", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The log containing the processing details of each business object in the setup offering CSV template export process.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "CSVTemplateReport":{ "title":"CSV Template Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The .zip file containing the template report files for the setup offering CSV template.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessResultsReport":{ "title":"Process Results Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The report that contains the results for each business object of the offering or functional area included in the CSV template export process.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessResultsSummaryReport":{ "title":"Process Results Summary Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The summary report for the setup offering CSV template export process.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } } } }

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : setupOfferingCSVTemplateExports-item-response

Match All

Show Source

• object ItemProperties
• object setupOfferingCSVTemplateExports-item
• object setupOfferingCSVTemplateExports-item-response-allOf[2]

{ "allOf":[ { "$ref":"#/components/schemas/ItemProperties" }, { "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-item" }, { "type":"object", "properties":{ "SetupOfferingCSVTemplateExportProcess":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-response" } } } } ] }

Nested Schema : ItemProperties

Type: object

Show Source

• links: array Links
  Title: Links

  The link relations associated with the resource instance.

{ "type":"object", "properties":{ "links":{ "title":"Links", "type":"array", "description":"The link relations associated with the resource instance.", "items":{ "$ref":"#/components/schemas/link" } } } }

Nested Schema : setupOfferingCSVTemplateExports-item

Type: object

Show Source

• FunctionalAreaCode: string
  Title: Functional Area Code

  The unique code of the setup functional area. This attribute is required when exporting setup offering CSV template for a functional area.
• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering. This attribute is required when exporting setup offering CSV template for an offering.

{ "type":"object", "properties":{ "OfferingCode":{ "title":"Offering Code", "type":"string", "description":"The unique code of the setup offering. This attribute is required when exporting setup offering CSV template for an offering.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "FunctionalAreaCode":{ "title":"Functional Area Code", "type":"string", "description":"The unique code of the setup functional area. This attribute is required when exporting setup offering CSV template for a functional area.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } } } }

Nested Schema : setupOfferingCSVTemplateExports-item-response-allOf[2]

Type: object

Show Source

• SetupOfferingCSVTemplateExportProcess: array SetupOfferingCSVTemplateExportProcess

{ "type":"object", "properties":{ "SetupOfferingCSVTemplateExportProcess":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-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 : 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." } } }

Nested Schema : SetupOfferingCSVTemplateExportProcess

Type: array

Show Source

• Array of: setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-response

{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-response" } }

Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-response

Match All

Show Source

• object ItemProperties
• object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item
• object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-response-allOf[2]

{ "allOf":[ { "$ref":"#/components/schemas/ItemProperties" }, { "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item" }, { "type":"object", "properties":{ "SetupOfferingCSVTemplateExportProcessResult":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-response" } } } } ] }

Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item

Type: object

Show Source

• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering for which the CSV template is generated.
• ProcessCompletedFlag: string
  Title: Process Complete

  Indicates whether the export process is complete. This attribute does not have a default value.
• ProcessId: integer (int32)
  Title: Process ID

  The unique identifier of the setup offering CSV template export process.

{ "type":"object", "properties":{ "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the setup offering CSV template export process.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "OfferingCode":{ "title":"Offering Code", "type":"string", "description":"The unique code of the setup offering for which the CSV template is generated.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessCompletedFlag":{ "title":"Process Complete", "type":"string", "description":"Indicates whether the export process is complete. This attribute does not have a default value.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true, "adf-properties":{ "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet" } } } } }

Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-item-response-allOf[2]

Type: object

Show Source

• SetupOfferingCSVTemplateExportProcessResult: array SetupOfferingCSVTemplateExportProcessResult

{ "type":"object", "properties":{ "SetupOfferingCSVTemplateExportProcessResult":{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-response" } } } }

Nested Schema : SetupOfferingCSVTemplateExportProcessResult

Type: array

Show Source

• Array of: setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-response

{ "type":"array", "items":{ "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-response" } }

Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item-response

Match All

Show Source

• object ItemProperties
• object setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item

{ "allOf":[ { "$ref":"#/components/schemas/ItemProperties" }, { "$ref":"#/components/schemas/setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item" } ] }

Nested Schema : setupOfferingCSVTemplateExports-SetupOfferingCSVTemplateExportProcess-SetupOfferingCSVTemplateExportProcessResult-item

Type: object

Show Source

• CSVTemplateReport: string (byte)
  Title: CSV Template Report

  Read Only: true

  Pattern: ^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$

  The .zip file containing the template report files for the setup offering CSV template.
• FileContent: string (byte)
  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 template files.
• FileName: string
  Title: File Name

  The name of the .zip file containing the setup offering CSV template files.
• ProcessId: integer (int32)
  Title: Process ID

  The unique identifier of the setup offering CSV template export process result.
• ProcessLog: string (byte)
  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 in the setup offering CSV template export process.
• ProcessName: string
  Title: Process Name

  Name of the setup offering CSV template export process.
• ProcessResultsReport: string (byte)
  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 CSV template export process.
• ProcessResultsSummaryReport: string (byte)
  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 setup offering CSV template export process.
• StatusCode: string
  Title: Status Code

  The status of the export process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.

{ "type":"object", "properties":{ "ProcessId":{ "title":"Process ID", "type":"integer", "description":"The unique identifier of the setup offering CSV template export process result.", "format":"int32", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "ProcessName":{ "title":"Process Name", "type":"string", "description":"Name of the setup offering CSV template export process.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "StatusCode":{ "title":"Status Code", "type":"string", "description":"The status of the export process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "FileName":{ "title":"File Name", "type":"string", "description":"The name of the .zip file containing the setup offering CSV template files.", "nullable":true, "x-queryable":true, "x-hints":{ "updatable":true } }, "FileContent":{ "title":"File Content", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The .zip file containing the setup offering CSV template files.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessLog":{ "title":"Process Log", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The log containing the processing details of each business object in the setup offering CSV template export process.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "CSVTemplateReport":{ "title":"CSV Template Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The .zip file containing the template report files for the setup offering CSV template.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessResultsReport":{ "title":"Process Results Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The report that contains the results for each business object of the offering or functional area included in the CSV template export process.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } }, "ProcessResultsSummaryReport":{ "title":"Process Results Summary Report", "pattern":"^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$", "type":"string", "description":"The summary report for the setup offering CSV template export process.", "format":"byte", "nullable":true, "readOnly":true, "x-queryable":true, "x-hints":{ "updatable":false } } } }

Back to Top

Examples

The following example shows how to create a setup offering CSV template export by submitting a POST request on the REST resource using cURL.

curl -i -u "<username>:<password>" -X POST https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports 

Example of Request Body

The following example shows the contents of the request body in JSON format:

{ "OfferingCode" : "XLE_FINANCIALS_JUR", "FunctionalAreaCode" : "ORA_ASK_ORGANIZATION_STRUCTURE", "SetupOfferingCSVTemplateExportProcess" : [{ "OfferingCode" : "XLE_FINANCIALS_JUR"}] }

Example of Response Header

The following shows an example of the response header.

Status: HTTP/1.1 200 OK Content-Type : application/vnd.oracle.adf.resourceitem+json

Example of Response Body

The following example shows the contents of the response body in JSON format:

{ "OfferingCode": "XLE_FINANCIALS_JUR", "FunctionalAreaCode": "ORA_ASK_ORGANIZATION_STRUCTURE", "SetupOfferingCSVTemplateExportProcess": [ { "ProcessId": 300100068274827, "OfferingCode": "XLE_FINANCIALS_JUR", "ProcessCompletedFlag": null, "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVTemplateExportProcess/300100068274827", "name": "SetupOfferingCSVTemplateExportProcess", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVTemplateExportProcess/300100068274827", "name": "SetupOfferingCSVTemplateExportProcess", "kind": "item" }, { "rel": "parent", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR", "name": "setupOfferingCSVTemplateExports", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVTemplateExportProcess/300100068274827/child/SetupOfferingCSVTemplateExportProcessResult", "name": "SetupOfferingCSVTemplateExportProcessResult", "kind": "collection" } ] } ], "links": [ { "rel": "self", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR", "name": "setupOfferingCSVTemplateExports", "kind": "item" }, { "rel": "canonical", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR", "name": "setupOfferingCSVTemplateExports", "kind": "item" }, { "rel": "child", "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVTemplateExports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVTemplateExportProcess", "name": "SetupOfferingCSVTemplateExportProcess", "kind": "collection" } ] }

Back to Top