Jump to

• Request
• Response
• Examples

Create a setup offering CSV import

post

/fscmRestApi/resources/11.13.18.05/setupOfferingCSVImports

Create a setup offering CSV import

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 setupOfferingCSVImports-item
• object type

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

Nested Schema : setupOfferingCSVImports-item

Type: object

Show Source

• FunctionalAreaCode: string
  Title: Functional Area Code

  The unique code of the setup functional area. This attribute is required when importing setup data for a functional area.
• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering. This attribute is required when importing setup data for an offering or a functional area.

{
    "type":"object",
    "properties":{
        "OfferingCode":{
            "title":"Offering Code",
            "type":"string",
            "description":"The unique code of the setup offering. This attribute is required when importing setup data for an offering or a functional area.",
            "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 importing setup data for a functional area.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        }
    }
}

Nested Schema : type

Type: object

Show Source

• SetupOfferingCSVImportProcess: array SetupOfferingCSVImportProcess

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

Nested Schema : SetupOfferingCSVImportProcess

Type: array

Show Source

• Array of: setupOfferingCSVImports-SetupOfferingCSVImportProcess-item-request

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

Nested Schema : setupOfferingCSVImports-SetupOfferingCSVImportProcess-item-request

Match All

Show Source

• object setupOfferingCSVImports-SetupOfferingCSVImportProcess-item
• object setupOfferingCSVImports-SetupOfferingCSVImportProcess-item-request-allOf[1]

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

Nested Schema : setupOfferingCSVImports-SetupOfferingCSVImportProcess-item

Type: object

Show Source

• FileContent: string (byte)
  Title: File Content

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

  The packaged file containing the setup offering CSV files.
• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering. This attribute is required when importing setup data for an offering or a functional area.
• ProcessCompletedFlag: string
  Title: Process Complete

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

  The unique identifier of the import process.
• SourceTargetDiffOkFlag: string
  Title: Option to Import Offering Setup Data Although Revisions Mismatch

  Indicates an option to proceed with the import even if the revision of the imported offering setup data is different from the revision of the target environment. If Y, the import process begins. If N, the import doesn't continue. The default value is N.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the import 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. This attribute is required when importing setup data for an offering or a functional area.",
            "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 packaged file containing the setup offering CSV files.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ProcessCompletedFlag":{
            "title":"Process Complete",
            "type":"string",
            "description":"Indicates whether the import 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"
                }
            }
        },
        "SourceTargetDiffOkFlag":{
            "title":"Option to Import Offering Setup Data Although Revisions Mismatch",
            "type":"string",
            "description":"Indicates an option to proceed with the import even if the revision of the imported offering setup data is different from the revision of the target environment. If Y, the import process begins. If N, the import doesn't continue. The default value is N.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-properties":{
                    "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet"
                }
            }
        }
    }
}

Nested Schema : setupOfferingCSVImports-SetupOfferingCSVImportProcess-item-request-allOf[1]

Type: object

Show Source

• SetupOfferingCSVImportProcessResult: array SetupOfferingCSVImportProcessResult

{
    "type":"object",
    "properties":{
        "SetupOfferingCSVImportProcessResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupOfferingCSVImports-SetupOfferingCSVImportProcess-SetupOfferingCSVImportProcessResult-item-request"
            }
        }
    }
}

Nested Schema : SetupOfferingCSVImportProcessResult

Type: array

Show Source

• Array of: object setupOfferingCSVImports-SetupOfferingCSVImportProcess-SetupOfferingCSVImportProcessResult-item

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/setupOfferingCSVImports-SetupOfferingCSVImportProcess-SetupOfferingCSVImportProcessResult-item-request"
    }
}

Nested Schema : setupOfferingCSVImports-SetupOfferingCSVImportProcess-SetupOfferingCSVImportProcessResult-item

Type: object

Show Source

• ProcessId: integer (int32)
  Title: Process ID

  The unique identifier of the import process.
• 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.
• ProcessName: string
  Title: Process Name

  Name of the import 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 import 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 import process.
• StatusCode: string
  Title: Status Code

  The status of the import 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 import process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ProcessName":{
            "title":"Process Name",
            "type":"string",
            "description":"Name of the import process.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "type":"string",
            "description":"The status of the import process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "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.",
            "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 import 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 import 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 setupOfferingCSVImports-item
• object type

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

Nested Schema : setupOfferingCSVImports-item

Type: object

Show Source

• FunctionalAreaCode: string
  Title: Functional Area Code

  The unique code of the setup functional area. This attribute is required when importing setup data for a functional area.
• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering. This attribute is required when importing setup data for an offering or a functional area.

{
    "type":"object",
    "properties":{
        "OfferingCode":{
            "title":"Offering Code",
            "type":"string",
            "description":"The unique code of the setup offering. This attribute is required when importing setup data for an offering or a functional area.",
            "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 importing setup data for a functional area.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        }
    }
}

Nested Schema : type

Type: object

Show Source

• SetupOfferingCSVImportProcess: array SetupOfferingCSVImportProcess

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

Nested Schema : SetupOfferingCSVImportProcess

Type: array

Show Source

• Array of: setupOfferingCSVImports-SetupOfferingCSVImportProcess-item-request

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

Nested Schema : setupOfferingCSVImports-SetupOfferingCSVImportProcess-item-request

Match All

Show Source

• object setupOfferingCSVImports-SetupOfferingCSVImportProcess-item
• object setupOfferingCSVImports-SetupOfferingCSVImportProcess-item-request-allOf[1]

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

Nested Schema : setupOfferingCSVImports-SetupOfferingCSVImportProcess-item

Type: object

Show Source

• FileContent: string (byte)
  Title: File Content

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

  The packaged file containing the setup offering CSV files.
• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering. This attribute is required when importing setup data for an offering or a functional area.
• ProcessCompletedFlag: string
  Title: Process Complete

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

  The unique identifier of the import process.
• SourceTargetDiffOkFlag: string
  Title: Option to Import Offering Setup Data Although Revisions Mismatch

  Indicates an option to proceed with the import even if the revision of the imported offering setup data is different from the revision of the target environment. If Y, the import process begins. If N, the import doesn't continue. The default value is N.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the import 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. This attribute is required when importing setup data for an offering or a functional area.",
            "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 packaged file containing the setup offering CSV files.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ProcessCompletedFlag":{
            "title":"Process Complete",
            "type":"string",
            "description":"Indicates whether the import 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"
                }
            }
        },
        "SourceTargetDiffOkFlag":{
            "title":"Option to Import Offering Setup Data Although Revisions Mismatch",
            "type":"string",
            "description":"Indicates an option to proceed with the import even if the revision of the imported offering setup data is different from the revision of the target environment. If Y, the import process begins. If N, the import doesn't continue. The default value is N.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-properties":{
                    "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet"
                }
            }
        }
    }
}

Nested Schema : setupOfferingCSVImports-SetupOfferingCSVImportProcess-item-request-allOf[1]

Type: object

Show Source

• SetupOfferingCSVImportProcessResult: array SetupOfferingCSVImportProcessResult

{
    "type":"object",
    "properties":{
        "SetupOfferingCSVImportProcessResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupOfferingCSVImports-SetupOfferingCSVImportProcess-SetupOfferingCSVImportProcessResult-item-request"
            }
        }
    }
}

Nested Schema : SetupOfferingCSVImportProcessResult

Type: array

Show Source

• Array of: object setupOfferingCSVImports-SetupOfferingCSVImportProcess-SetupOfferingCSVImportProcessResult-item

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/setupOfferingCSVImports-SetupOfferingCSVImportProcess-SetupOfferingCSVImportProcessResult-item-request"
    }
}

Nested Schema : setupOfferingCSVImports-SetupOfferingCSVImportProcess-SetupOfferingCSVImportProcessResult-item

Type: object

Show Source

• ProcessId: integer (int32)
  Title: Process ID

  The unique identifier of the import process.
• 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.
• ProcessName: string
  Title: Process Name

  Name of the import 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 import 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 import process.
• StatusCode: string
  Title: Status Code

  The status of the import 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 import process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ProcessName":{
            "title":"Process Name",
            "type":"string",
            "description":"Name of the import process.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "type":"string",
            "description":"The status of the import process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "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.",
            "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 import 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 import 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 : setupOfferingCSVImports-item-response

Match All

Show Source

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/setupOfferingCSVImports-item"
        },
        {
            "type":"object",
            "properties":{
                "SetupOfferingCSVImportProcess":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/setupOfferingCSVImports-SetupOfferingCSVImportProcess-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 : setupOfferingCSVImports-item

Type: object

Show Source

• FunctionalAreaCode: string
  Title: Functional Area Code

  The unique code of the setup functional area. This attribute is required when importing setup data for a functional area.
• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering. This attribute is required when importing setup data for an offering or a functional area.

{
    "type":"object",
    "properties":{
        "OfferingCode":{
            "title":"Offering Code",
            "type":"string",
            "description":"The unique code of the setup offering. This attribute is required when importing setup data for an offering or a functional area.",
            "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 importing setup data for a functional area.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        }
    }
}

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

Type: object

Show Source

• SetupOfferingCSVImportProcess: array SetupOfferingCSVImportProcess

{
    "type":"object",
    "properties":{
        "SetupOfferingCSVImportProcess":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupOfferingCSVImports-SetupOfferingCSVImportProcess-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":{
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "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."
        },
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "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 : SetupOfferingCSVImportProcess

Type: array

Show Source

• Array of: setupOfferingCSVImports-SetupOfferingCSVImportProcess-item-response

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

Nested Schema : setupOfferingCSVImports-SetupOfferingCSVImportProcess-item-response

Match All

Show Source

• object ItemProperties
• object setupOfferingCSVImports-SetupOfferingCSVImportProcess-item
• object setupOfferingCSVImports-SetupOfferingCSVImportProcess-item-response-allOf[2]

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

Nested Schema : setupOfferingCSVImports-SetupOfferingCSVImportProcess-item

Type: object

Show Source

• FileContent: string (byte)
  Title: File Content

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

  The packaged file containing the setup offering CSV files.
• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering. This attribute is required when importing setup data for an offering or a functional area.
• ProcessCompletedFlag: string
  Title: Process Complete

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

  The unique identifier of the import process.
• SourceTargetDiffOkFlag: string
  Title: Option to Import Offering Setup Data Although Revisions Mismatch

  Indicates an option to proceed with the import even if the revision of the imported offering setup data is different from the revision of the target environment. If Y, the import process begins. If N, the import doesn't continue. The default value is N.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the import 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. This attribute is required when importing setup data for an offering or a functional area.",
            "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 packaged file containing the setup offering CSV files.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ProcessCompletedFlag":{
            "title":"Process Complete",
            "type":"string",
            "description":"Indicates whether the import 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"
                }
            }
        },
        "SourceTargetDiffOkFlag":{
            "title":"Option to Import Offering Setup Data Although Revisions Mismatch",
            "type":"string",
            "description":"Indicates an option to proceed with the import even if the revision of the imported offering setup data is different from the revision of the target environment. If Y, the import process begins. If N, the import doesn't continue. The default value is N.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-properties":{
                    "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet"
                }
            }
        }
    }
}

Nested Schema : setupOfferingCSVImports-SetupOfferingCSVImportProcess-item-response-allOf[2]

Type: object

Show Source

• SetupOfferingCSVImportProcessResult: array SetupOfferingCSVImportProcessResult

{
    "type":"object",
    "properties":{
        "SetupOfferingCSVImportProcessResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupOfferingCSVImports-SetupOfferingCSVImportProcess-SetupOfferingCSVImportProcessResult-item-response"
            }
        }
    }
}

Nested Schema : SetupOfferingCSVImportProcessResult

Type: array

Show Source

• Array of: setupOfferingCSVImports-SetupOfferingCSVImportProcess-SetupOfferingCSVImportProcessResult-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/setupOfferingCSVImports-SetupOfferingCSVImportProcess-SetupOfferingCSVImportProcessResult-item-response"
    }
}

Nested Schema : setupOfferingCSVImports-SetupOfferingCSVImportProcess-SetupOfferingCSVImportProcessResult-item-response

Match All

Show Source

• object ItemProperties
• object setupOfferingCSVImports-SetupOfferingCSVImportProcess-SetupOfferingCSVImportProcessResult-item

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/setupOfferingCSVImports-SetupOfferingCSVImportProcess-SetupOfferingCSVImportProcessResult-item"
        }
    ]
}

Nested Schema : setupOfferingCSVImports-SetupOfferingCSVImportProcess-SetupOfferingCSVImportProcessResult-item

Type: object

Show Source

• ProcessId: integer (int32)
  Title: Process ID

  The unique identifier of the import process.
• 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.
• ProcessName: string
  Title: Process Name

  Name of the import 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 import 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 import process.
• StatusCode: string
  Title: Status Code

  The status of the import 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 import process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ProcessName":{
            "title":"Process Name",
            "type":"string",
            "description":"Name of the import process.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "type":"string",
            "description":"The status of the import process. The valid values are NOT_STARTED, IN_PROGRESS, COMPLETED, COMPLETED_WARNINGS, and COMPLETED_ERRORS.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "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.",
            "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 import 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 import 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 import 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/setupOfferingCSVImports

Example of Request Body

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

Note:

The value of FileContent is in BASE64 encoded zip format.

{
  "OfferingCode" : "XLE_FINANCIALS_JUR",
  "FunctionalAreaCode" : "ORA_ASK_ORGANIZATION_STRUCTURE",
  "SetupOfferingCSVImportProcess" : [{  "OfferingCode" : "XLE_FINANCIALS_JUR",
                                        "SourceTargetDiffOkFlag" : "N",
                                        "FileContent": "UEsDBBQACAgIAFqhi00AAAAAAAAAAAAAAAAUAAAATEVfMTIxNDQxNjcxMzY1NS5jc3ZVzkEOwiAQBdC9x2DtKaSNm0YT0QNMYGgmsQOBsQmeXqq06gp48z8ZZVB0cKj26pxGYHqCUOBGF/SYkC0eU3jEE0wLtkMnBEF3KOu91roq9dmhYJqIgeVa4iIDZLlFV8ct8oUhjMR/8vnTlNx7j1ZoXkv6DjmTJ/u74xYyAklacsOe3Zt2L1BLBwgN+fnbhgAAAOkAAABQSwMEFAAICAgAWqGLTQAAAAAAAAAAAAAAABwAAABGVU5fQlVfU0VSVklDRV9QUk9WSURFUlMuY3N27L1Zl9w2si76fn9FLq39cO/aLgrzkC/3cOzWblmqrZLcp/vFKy2l7TotVblLJfd2//oDgEMxB5IAySTIzFott5RgAJn8AggEAjG8iD/fbu8eo29vNl+2L757kX98+/DL5u7235vH2/u7+P6TfnD9cP/77aftQ0VZNhyh/fDb18eH7eZL9u3uo25+9Uk1Jvf/ujvSHN79UY70Nfu8+UU3qae/b4sPserxuP0U/VH+W3VMVIv6+Hrz9fHDb5+qx0+fDwhe3/9ye6dabv74mv7889Z8QUGUv3H8efP16+3Ptx/r75E/qjrcPG4eHnd6VY/Su0/Fg/Jljg5YPjw65MHDctD/58UPt1/VIKub7cPvtx+3X1fv/jNRHY60/sd//P//8R9Jeh2+e/99+uY9PE5l3RcioP8f6v9/o/77m/ov+3Dz6q3+gAAkLwF/CdAK0jUmayQCyihH1JoK5ATiJUQvITTd3vwYqa5v0pubHz+8efVef70UqjtUf9QHwjUpeoldqT2C6I6h+p811UVgiPVbEhcICUHWVBcBIczf0gFCbAUhnh5CJSl/edh+/boKP325vbtVu4oRsrkMPfbEwBHHsJnCqu+RlRxeX//46vvr1z/Gb9/cfHj9PnzzvoJK/XS8AnBN+ZqIAJrVaklPaSAMjGmSwTgWKQIMoYywFBCMOAIZ1RSQU5TTEFUSU9OLmNzdlBLAQIUABQACAgIAFqhi01cQIrlZxcAAPT2AAAhAAAAAAAAAAAAAAAAACeIAQBPUkFfSU5WX09SR19QQVJFTlRfRk9SX0lOVk9SRy5jc3ZQSwECFAAUAAgICABaoYtN27LD73dcAAAGvgYAHgAAAAAAAAAAAAAAAADdnwEASU5WX09SR0FOSVpBVElPTl9QQVJBTUVURVIuY3N2UEsBAhQAFAAICAgAWqGLTeEXQUC4EgAA0owBACUAAAAAAAAAAAAAAAAAoPwBAE9SQV9JTlZfSVRFTV9PUkdfQ0hJTERfRk9SX0lOVk9SRy5jc3ZQSwECFAAUAAgICABaoYtNrbMidnoEAADqIAAAJgAAAAAAAAAAAAAAAACrDwIAT1JBX0lOVl9JVEVNX09SR19QQVJFTlRfRk9SX0lOVk9SRy5jc3ZQSwECFAAUAAgICABaoYtN8I2TmY8MAADJfQAAGgAAAAAAAAAAAAAAAAB5FAIAQVNNX1NFVFVQX0NTVl9NRVRBREFUQS54bWxQSwUGAAAAABUAFQAcBgAAUCECAA=="}]
}

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",
    "SetupOfferingCSVImportProcess": [
        {
            "ProcessId": 300100068274939,
            "OfferingCode": "XLE_FINANCIALS_JUR",
            "ProcessCompletedFlag": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVImports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVImportProcess/300100068274939",
                    "name": "SetupOfferingCSVImportProcess",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVImports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVImportProcess/300100068274939",
                    "name": "SetupOfferingCSVImportProcess",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVImports/XLE_FINANCIALS_JUR",
                    "name": "setupOfferingCSVImports",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVImports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVImportProcess/300100068274939/child/SetupOfferingCSVImportProcessResult",
                    "name": "SetupOfferingCSVImportProcessResult",
                    "kind": "collection"
                },
                {
                    "rel": "enclosure",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVImports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVImportProcess/300100068274939/enclosure/FileContent",
                    "name": "FileContent",
                    "kind": "other"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVImports/XLE_FINANCIALS_JUR",
            "name": "setupOfferingCSVImports",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVImports/XLE_FINANCIALS_JUR",
            "name": "setupOfferingCSVImports",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupOfferingCSVImports/XLE_FINANCIALS_JUR/child/SetupOfferingCSVImportProcess",
            "name": "SetupOfferingCSVImportProcess",
            "kind": "collection"
        }
    ]
}

Back to Top