Jump to

• Request
• Response
• Examples

Create a setup task CSV import

post

/fscmRestApi/resources/11.13.18.05/setupTaskCSVImports

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

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

Nested Schema : setupTaskCSVImports-item

Type: object

Show Source

• ImportSupportedFlag: string
  Title: Import from CSV Support

  Indicates whether CSV import is supported for the setup task.
• TaskCode: string
  Title: Task Code

  Maximum Length: 255

  The unique code of the setup task for which the CSV data files are imported.

{
    "type":"object",
    "properties":{
        "TaskCode":{
            "title":"Task Code",
            "maxLength":255,
            "type":"string",
            "description":"The unique code of the setup task for which the CSV data files are imported.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ImportSupportedFlag":{
            "title":"Import from CSV Support",
            "type":"string",
            "description":"Indicates whether CSV import is supported for the setup task.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-properties":{
                    "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet"
                }
            }
        }
    }
}

Nested Schema : type

Type: object

Show Source

• SetupTaskCSVImportProcess: array SetupTaskCSVImportProcess

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

Nested Schema : SetupTaskCSVImportProcess

Type: array

Show Source

• Array of: setupTaskCSVImports-SetupTaskCSVImportProcess-item-request

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

Nested Schema : setupTaskCSVImports-SetupTaskCSVImportProcess-item-request

Match All

Show Source

• object setupTaskCSVImports-SetupTaskCSVImportProcess-item
• object setupTaskCSVImports-SetupTaskCSVImportProcess-item-request-allOf[1]

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

Nested Schema : setupTaskCSVImports-SetupTaskCSVImportProcess-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 .zip file containing the setup task CSV files.
• ProcessCompletedFlag: string
  Title: Process Complete

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

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

  Indicates an option to proceed with the import even if the revision of the imported task 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.
• TaskCode: string
  Title: Task Code

  The unique identifier of the setup task CSV import process.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the setup task CSV import process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "TaskCode":{
            "title":"Task Code",
            "type":"string",
            "description":"The unique identifier of the setup task CSV import process.",
            "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 task CSV files.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ProcessCompletedFlag":{
            "title":"Process Complete",
            "type":"string",
            "description":"Indicates whether the setup task CSV import 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"
                }
            }
        },
        "SourceTargetDiffOkFlag":{
            "title":"Option to Import Task Setup Data Although Revisions Mismatch",
            "type":"string",
            "description":"Indicates an option to proceed with the import even if the revision of the imported task 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 : setupTaskCSVImports-SetupTaskCSVImportProcess-item-request-allOf[1]

Type: object

Show Source

• SetupTaskCSVImportProcessResult: array SetupTaskCSVImportProcessResult

{
    "type":"object",
    "properties":{
        "SetupTaskCSVImportProcessResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item-request"
            }
        }
    }
}

Nested Schema : SetupTaskCSVImportProcessResult

Type: array

Show Source

• Array of: object setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item-request"
    }
}

Nested Schema : setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item

Type: object

Show Source

• ProcessId: integer (int32)
  Title: Process ID

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

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

  The status of the setup task CSV 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 setup task CSV import process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ProcessName":{
            "title":"Process Name",
            "type":"string",
            "description":"Name of the setup task CSV import process.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "type":"string",
            "description":"The status of the setup task CSV 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 in the setup task CSV import process.",
            "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 task included in the CSV 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 setup task CSV 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 setupTaskCSVImports-item
• object type

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

Nested Schema : setupTaskCSVImports-item

Type: object

Show Source

• ImportSupportedFlag: string
  Title: Import from CSV Support

  Indicates whether CSV import is supported for the setup task.
• TaskCode: string
  Title: Task Code

  Maximum Length: 255

  The unique code of the setup task for which the CSV data files are imported.

{
    "type":"object",
    "properties":{
        "TaskCode":{
            "title":"Task Code",
            "maxLength":255,
            "type":"string",
            "description":"The unique code of the setup task for which the CSV data files are imported.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ImportSupportedFlag":{
            "title":"Import from CSV Support",
            "type":"string",
            "description":"Indicates whether CSV import is supported for the setup task.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-properties":{
                    "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet"
                }
            }
        }
    }
}

Nested Schema : type

Type: object

Show Source

• SetupTaskCSVImportProcess: array SetupTaskCSVImportProcess

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

Nested Schema : SetupTaskCSVImportProcess

Type: array

Show Source

• Array of: setupTaskCSVImports-SetupTaskCSVImportProcess-item-request

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

Nested Schema : setupTaskCSVImports-SetupTaskCSVImportProcess-item-request

Match All

Show Source

• object setupTaskCSVImports-SetupTaskCSVImportProcess-item
• object setupTaskCSVImports-SetupTaskCSVImportProcess-item-request-allOf[1]

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

Nested Schema : setupTaskCSVImports-SetupTaskCSVImportProcess-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 .zip file containing the setup task CSV files.
• ProcessCompletedFlag: string
  Title: Process Complete

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

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

  Indicates an option to proceed with the import even if the revision of the imported task 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.
• TaskCode: string
  Title: Task Code

  The unique identifier of the setup task CSV import process.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the setup task CSV import process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "TaskCode":{
            "title":"Task Code",
            "type":"string",
            "description":"The unique identifier of the setup task CSV import process.",
            "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 task CSV files.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ProcessCompletedFlag":{
            "title":"Process Complete",
            "type":"string",
            "description":"Indicates whether the setup task CSV import 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"
                }
            }
        },
        "SourceTargetDiffOkFlag":{
            "title":"Option to Import Task Setup Data Although Revisions Mismatch",
            "type":"string",
            "description":"Indicates an option to proceed with the import even if the revision of the imported task 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 : setupTaskCSVImports-SetupTaskCSVImportProcess-item-request-allOf[1]

Type: object

Show Source

• SetupTaskCSVImportProcessResult: array SetupTaskCSVImportProcessResult

{
    "type":"object",
    "properties":{
        "SetupTaskCSVImportProcessResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item-request"
            }
        }
    }
}

Nested Schema : SetupTaskCSVImportProcessResult

Type: array

Show Source

• Array of: object setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item-request"
    }
}

Nested Schema : setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item

Type: object

Show Source

• ProcessId: integer (int32)
  Title: Process ID

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

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

  The status of the setup task CSV 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 setup task CSV import process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ProcessName":{
            "title":"Process Name",
            "type":"string",
            "description":"Name of the setup task CSV import process.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "type":"string",
            "description":"The status of the setup task CSV 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 in the setup task CSV import process.",
            "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 task included in the CSV 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 setup task CSV 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 : setupTaskCSVImports-item-response

Match All

Show Source

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

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

Type: object

Show Source

• ImportSupportedFlag: string
  Title: Import from CSV Support

  Indicates whether CSV import is supported for the setup task.
• TaskCode: string
  Title: Task Code

  Maximum Length: 255

  The unique code of the setup task for which the CSV data files are imported.

{
    "type":"object",
    "properties":{
        "TaskCode":{
            "title":"Task Code",
            "maxLength":255,
            "type":"string",
            "description":"The unique code of the setup task for which the CSV data files are imported.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ImportSupportedFlag":{
            "title":"Import from CSV Support",
            "type":"string",
            "description":"Indicates whether CSV import is supported for the setup task.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true,
                "adf-properties":{
                    "JboValueMapProperty":"oracle.jbo.valuemaps.BooleanYNPropertySet"
                }
            }
        }
    }
}

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

Type: object

Show Source

• SetupTaskCSVImportProcess: array SetupTaskCSVImportProcess

{
    "type":"object",
    "properties":{
        "SetupTaskCSVImportProcess":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupTaskCSVImports-SetupTaskCSVImportProcess-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 : SetupTaskCSVImportProcess

Type: array

Show Source

• Array of: setupTaskCSVImports-SetupTaskCSVImportProcess-item-response

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

Nested Schema : setupTaskCSVImports-SetupTaskCSVImportProcess-item-response

Match All

Show Source

• object ItemProperties
• object setupTaskCSVImports-SetupTaskCSVImportProcess-item
• object setupTaskCSVImports-SetupTaskCSVImportProcess-item-response-allOf[2]

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

Nested Schema : setupTaskCSVImports-SetupTaskCSVImportProcess-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 .zip file containing the setup task CSV files.
• ProcessCompletedFlag: string
  Title: Process Complete

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

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

  Indicates an option to proceed with the import even if the revision of the imported task 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.
• TaskCode: string
  Title: Task Code

  The unique identifier of the setup task CSV import process.

{
    "type":"object",
    "properties":{
        "ProcessId":{
            "title":"Process ID",
            "type":"integer",
            "description":"The unique identifier of the setup task CSV import process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "TaskCode":{
            "title":"Task Code",
            "type":"string",
            "description":"The unique identifier of the setup task CSV import process.",
            "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 task CSV files.",
            "format":"byte",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":false
            }
        },
        "ProcessCompletedFlag":{
            "title":"Process Complete",
            "type":"string",
            "description":"Indicates whether the setup task CSV import 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"
                }
            }
        },
        "SourceTargetDiffOkFlag":{
            "title":"Option to Import Task Setup Data Although Revisions Mismatch",
            "type":"string",
            "description":"Indicates an option to proceed with the import even if the revision of the imported task 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 : setupTaskCSVImports-SetupTaskCSVImportProcess-item-response-allOf[2]

Type: object

Show Source

• SetupTaskCSVImportProcessResult: array SetupTaskCSVImportProcessResult

{
    "type":"object",
    "properties":{
        "SetupTaskCSVImportProcessResult":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item-response"
            }
        }
    }
}

Nested Schema : SetupTaskCSVImportProcessResult

Type: array

Show Source

• Array of: setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item-response

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item-response"
    }
}

Nested Schema : setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item-response

Match All

Show Source

• object ItemProperties
• object setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item

{
    "allOf":[
        {
            "$ref":"#/components/schemas/ItemProperties"
        },
        {
            "$ref":"#/components/schemas/setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item"
        }
    ]
}

Nested Schema : setupTaskCSVImports-SetupTaskCSVImportProcess-SetupTaskCSVImportProcessResult-item

Type: object

Show Source

• ProcessId: integer (int32)
  Title: Process ID

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

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

  The status of the setup task CSV 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 setup task CSV import process.",
            "format":"int32",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "ProcessName":{
            "title":"Process Name",
            "type":"string",
            "description":"Name of the setup task CSV import process.",
            "nullable":true,
            "x-queryable":true,
            "x-hints":{
                "updatable":true
            }
        },
        "StatusCode":{
            "title":"Status Code",
            "type":"string",
            "description":"The status of the setup task CSV 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 in the setup task CSV import process.",
            "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 task included in the CSV 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 setup task CSV 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 task 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/setupTaskCSVImports

Example of Request Body

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

{
  "TaskCode" : "HZ_MANAGE_RESOURCE_ROLES",
  "SetupTaskCSVImportProcess" : [{  "TaskCode" : "HZ_MANAGE_RESOURCE_ROLES",
							 	    "SourceTargetDiffOkFlag" : "N",
								    "FileContent": "UEsDBBQACAgIADypokoAAAAAAAAAAAAAAAASAAAASlRGX1JTX1JPTEVTX0IuY3N2fVDRjsIgEHz3KwzP9xNYq2fS4qWoiU9kLRsloUDo5i7+/ZWUanNnfCDMTGaHYVnjLR7uAQuvkX2wRDOUiBr1xsJ1IDV2F4yZcN0ZZ3qKQH7SKoSHFxxcn+aWzDdmkuIFdNNLa+zbaAIZ7waliAiEenVPcdDTMegHn3qlqvLHUHvDyBas+ORClJWSvCplisj8izcHUTaq3jaDKoZzzveEz0/3MruXNRd8W6aJ9P0Uqfi63ol/rNqf1HxxJ7AvyrQ3cA6tChDJYVTBRwKrYNzeny5z/H5wXPtYcnOUu72Yg5fVfgFQSwcIdbMYV+MAAADmAQAAUEsDBBQACAgIADypokoAAAAAAAAAAAAAAAAaAAAAQVNNX1NFVFVQX0NTVl9NRVRBREFUQS54bWzNVlFzmkAQfu+vYPKs5aDVaIYwgxQbW4QMR5xMX5gTdpQOgoUjmfz73p2igNGYtJn2ydvl+75ddj9AbRovckLjLL3NsxCKwsSzKVASEUpmrv5BkiTtJMTLHgWKA7fXJ5HeHQ6HmryPWwiHrECfkpQsQPKgyMo8ZIcsgSJQkXKJekgN0KDXV5Vg2N8LCVpL6gsUYR6veXtvUKyz28KEgs65XdTrIlVSlSs0vOr1P36u3ZoAVUR3/hNCipdZTkWnNz+CqeEYX63As7B755ns4NoW1uQ2sqngP61B9w38vQKKRIUxc2BFo9HTOGGj57CALSTAljebmJYmN69XrPYOR2URp+x3U6C2UaWivIrV8MG5btjimqL7oXzzx4GHNyMLRoHvGQ62DX/iOpp8jNNSJjRc8ryUlklyfUHzEi7kFuh+lRiU5vG8pGDHBdV3A+zYpKB362gbcTdxMXGoGYfB0kXJjNfBwnY81OQD2YOqThbBLaFLXa4My4Vnbitkg21k/JykRSK2ciwvSKKFXY1mdZ7G8KuENARd0eRGXNu//GYD/E/WeV+78NmbbH7CFvxJFQEGiCAaJ2TRmcJqDrk4GtEqThmJTSbbZGwgW5R4d21hIY0fQByPmu6US3kHvBP8GLM7gvzvuvEfGusVPOX4q4+vuYZ8dtsHLBxma5iRpIQa9ZThnyX8idlZgb0mBsoAnxBSEEKqMuj3LweKGE8b855PzL7WKNv5i9WsPwqafAx1hpaIdfPGcBzLDrAhvp4nkOdK8sbOlxXoU+59eddncjZ/uA6wh6ovYPTfUEsHCJ/X4ztZAgAA2AkAAFBLAQIUABQACAgIADypokp1sxhX4wAAAOYBAAASAAAAAAAAAAAAAAAAAAAAAABKVEZfUlNfUk9MRVNfQi5jc3ZQSwECFAAUAAgICAA8qaJKn9fjO1kCAADYCQAAGgAAAAAAAAAAAAAA"}]
}

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
               application/json

Example of Response Body

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

{
    "TaskCode": "HZ_MANAGE_RESOURCE_ROLES",
    "ImportSupportedFlag": null,
    "SetupTaskCSVImportProcess": [
        {
            "ProcessId": 300100022143420,
            "TaskCode": "HZ_MANAGE_RESOURCE_ROLES",
            "ProcessCompletedFlag": null,
            "links": [
                {
                    "rel": "self",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVImports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVImportProcess/300100022143420",
                    "name": "SetupTaskCSVImportProcess",
                    "kind": "item"
                },
                {
                    "rel": "canonical",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVImports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVImportProcess/300100022143420",
                    "name": "SetupTaskCSVImportProcess",
                    "kind": "item"
                },
                {
                    "rel": "parent",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVImports/HZ_MANAGE_RESOURCE_ROLES",
                    "name": "setupTaskCSVImports",
                    "kind": "item"
                },
                {
                    "rel": "child",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVImports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVImportProcess/300100022143420/child/SetupTaskCSVImportProcessResult",
                    "name": "SetupTaskCSVImportProcessResult",
                    "kind": "collection"
                },
                {
                    "rel": "enclosure",
                    "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVImports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVImportProcess/300100022143420/enclosure/FileContent",
                    "name": "FileContent",
                    "kind": "other"
                }
            ]
        }
    ],
    "links": [
        {
            "rel": "self",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVImports/HZ_MANAGE_RESOURCE_ROLES",
            "name": "setupTaskCSVImports",
            "kind": "item"
        },
        {
            "rel": "canonical",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVImports/HZ_MANAGE_RESOURCE_ROLES",
            "name": "setupTaskCSVImports",
            "kind": "item"
        },
        {
            "rel": "child",
            "href": "https://servername.fa.us2.oraclecloud.com/fscmRestApi/resources/11.13.18.05/setupTaskCSVImports/HZ_MANAGE_RESOURCE_ROLES/child/SetupTaskCSVImportProcess",
            "name": "SetupTaskCSVImportProcess",
            "kind": "collection"
        }
    ]
}

Back to Top