Jump to

• Request
• Response

Get a setup offering CSV export

get

/fscmRestApi/resources/11.13.18.05/setupOfferingCSVExports/{OfferingCode}

Get a setup offering CSV export

Request

Path Parameters

• OfferingCode(required): string
  The short code of the setup offering. This attribute is required.

Query Parameters

• dependency: string
  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>
• 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 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
• 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
  
• onlyData: boolean
  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

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : setupOfferingCSVExports-item-response

Match All

Show Source

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

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/setupOfferingCSVExports-item"
        },
        {
            "type":"object",
            "properties":{
                "SetupOfferingCSVExportCriteria":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/setupOfferingCSVExports-SetupOfferingCSVExportCriteria-item-response"
                    }
                },
                "SetupOfferingCSVExportProcess":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/setupOfferingCSVExports-SetupOfferingCSVExportProcess-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 : setupOfferingCSVExports-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 data for a functional area.
• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering. This attribute is required when exporting 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 exporting 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 exporting setup data for a functional area.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        }
    }
}

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

Type: object

Show Source

• SetupOfferingCSVExportCriteria: array SetupOfferingCSVExportCriteria
• SetupOfferingCSVExportProcess: array SetupOfferingCSVExportProcess

{
    "type":"object",
    "properties":{
        "SetupOfferingCSVExportCriteria":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupOfferingCSVExports-SetupOfferingCSVExportCriteria-item-response"
            }
        },
        "SetupOfferingCSVExportProcess":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupOfferingCSVExports-SetupOfferingCSVExportProcess-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 : SetupOfferingCSVExportCriteria

Type: array

Show Source

• Array of: setupOfferingCSVExports-SetupOfferingCSVExportCriteria-item-response

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

Nested Schema : SetupOfferingCSVExportProcess

Type: array

Show Source

• Array of: setupOfferingCSVExports-SetupOfferingCSVExportProcess-item-response

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

Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportCriteria-item-response

Match All

Show Source

• object ItemProperties
• object schema

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/setupOfferingCSVExports-SetupOfferingCSVExportCriteria-item"
        }
    ]
}

Nested Schema : schema

Type: object

Show Source

• AttributeName: string
  Title: Attribute Name

  Name of the attribute that defines the filter criteria for the business object.
• AttributeSet: string
  Title: Attribute Set

  Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition.
• AttributeValue: string
  Title: Attribute Value

  Value applicable to the attribute that defines the filter criteria for a business object.
• BusinessObjectCode: string
  Title: Business Object Code

  The unique code of the business object.
• OfferingCode: string
  Title: Offering Code

  The unique code of the setup offering. This attribute is required when exporting setup data for an offering or a functional area.
• ProcessId: integer (int32)
  Title: Process ID

  The unique identifier of the export process.

{
    "type":"object",
    "properties":{
        "OfferingCode":{
            "title":"Offering Code",
            "type":"string",
            "description":"The unique code of the setup offering. This attribute is required when exporting setup data for an offering or a functional area.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the export process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "BusinessObjectCode":{
            "title":"Business Object Code",
            "type":"string",
            "description":"The unique code of the business object.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "AttributeSet":{
            "title":"Attribute Set",
            "type":"string",
            "description":"Name of the attribute set that identifies a group of attribute-value pairs and forms a single filter condition.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "AttributeName":{
            "title":"Attribute Name",
            "type":"string",
            "description":"Name of the attribute that defines the filter criteria for the business object.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "AttributeValue":{
            "title":"Attribute Value",
            "type":"string",
            "description":"Value applicable to the attribute that defines the filter criteria for a business object.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        }
    }
}

Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-item-response

Match All

Show Source

• object ItemProperties
• object setupOfferingCSVExports-SetupOfferingCSVExportProcess-item
• object setupOfferingCSVExports-SetupOfferingCSVExportProcess-item-response-allOf[2]

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

Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-item

Type: object

Show Source

• OfferingCode: string
  Title: Offering Code

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

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

  The unique identifier of the export process.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the 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. This attribute is required when exporting setup data for an offering or a functional area.",
            "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 doesn't have a default value.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-properties":{
                    "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet"
                }
            }
        }
    }
}

Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-item-response-allOf[2]

Type: object

Show Source

• SetupOfferingCSVExportProcessResult: array SetupOfferingCSVExportProcessResult

{
    "type":"object",
    "properties":{
        "SetupOfferingCSVExportProcessResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupOfferingCSVExports-SetupOfferingCSVExportProcess-SetupOfferingCSVExportProcessResult-item-response"
            }
        }
    }
}

Nested Schema : SetupOfferingCSVExportProcessResult

Type: array

Show Source

• Array of: setupOfferingCSVExports-SetupOfferingCSVExportProcess-SetupOfferingCSVExportProcessResult-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/setupOfferingCSVExports-SetupOfferingCSVExportProcess-SetupOfferingCSVExportProcessResult-item-response"
    }
}

Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-SetupOfferingCSVExportProcessResult-item-response

Match All

Show Source

• object ItemProperties
• object setupOfferingCSVExports-SetupOfferingCSVExportProcess-SetupOfferingCSVExportProcessResult-item

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/setupOfferingCSVExports-SetupOfferingCSVExportProcess-SetupOfferingCSVExportProcessResult-item"
        }
    ]
}

Nested Schema : setupOfferingCSVExports-SetupOfferingCSVExportProcess-SetupOfferingCSVExportProcessResult-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 packaged file containing the CSV template report files.
• 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 files.
• FileName: string
  Title: File Name

  The name of the packaged file containing the setup offering
• ProcessId: integer (int32)
  Title: Process ID

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

  Name of the 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 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 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 export process result.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ProcessName":{
            "title":"Process Name",
            "type":"string",
            "description":"Name of the 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 packaged file containing the setup offering",
            "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 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.",
            "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 packaged file containing the CSV template report files.",
            "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 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 export process.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        }
    }
}

Back to Top