Jump to

• Request
• Response

Create an extract definition

post

/hcmRestApi/resources/11.13.18.05/extractConfiguratorTemplates/action/createExtractFromConfigurator

Creates an extract definition using the selected template and the specified configuration settings.

Request

Header Parameters

• Metadata-Context: string
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version: string
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

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

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

Root Schema : schema

Type: object

Show Source

• criteriaValues: object criteriaValues
  Additional Properties Allowed: additionalProperties

  Filter criteria values for the extract creation process.
• extractObjects: object extractObjects
  Additional Properties Allowed: additionalProperties

  Extract objects to include when creating the extract definition from the template.
• pAdditionalDtls: string
  Additional details for the extract configuration.
• pAliasLkpCode: string
  Alias lookup code for the extract definition.
• pChangesOnly: string
  Indicates whether the extract captures only data changes. Valid values are true and false.
• pDefinitionName: string
  Name of the extract definition created from the template.
• pDescription: string
  Description of the new extract definition.
• pEventEnabled: string
  Indicates whether event processing is enabled for this extract. Valid values are true and false.
• pextractdefinitionid: number
  Extract definition identifier to assign to the created extract.
• plegislativedatagroupid: number
  Legislative data group identifier for the new extract definition.
• psourceextractdefinitionid: number
  Source extract definition identifier from which to build the new extract.
• pVendor: string
  Consumer for whom the extract is created.

{
    "type":"object",
    "properties":{
        "criteriaValues":{
            "type":"object",
            "additionalProperties":{
                "type":"array",
                "items":{
                    "type":"string"
                }
            },
            "description":"Filter criteria values for the extract creation process.",
            "nullable":true
        },
        "pextractdefinitionid":{
            "type":"number",
            "description":"Extract definition identifier to assign to the created extract.",
            "nullable":true
        },
        "pChangesOnly":{
            "type":"string",
            "description":"Indicates whether the extract captures only data changes. Valid values are true and false.",
            "nullable":true
        },
        "extractObjects":{
            "type":"object",
            "additionalProperties":{
                "type":"object",
                "additionalProperties":{
                    "type":"string"
                }
            },
            "description":"Extract objects to include when creating the extract definition from the template.",
            "nullable":true
        },
        "pVendor":{
            "type":"string",
            "description":"Consumer for whom the extract is created.",
            "nullable":true
        },
        "pAliasLkpCode":{
            "type":"string",
            "description":"Alias lookup code for the extract definition.",
            "nullable":true
        },
        "pEventEnabled":{
            "type":"string",
            "description":"Indicates whether event processing is enabled for this extract. Valid values are true and false.",
            "nullable":true
        },
        "psourceextractdefinitionid":{
            "type":"number",
            "description":"Source extract definition identifier from which to build the new extract.",
            "nullable":true
        },
        "plegislativedatagroupid":{
            "type":"number",
            "description":"Legislative data group identifier for the new extract definition.",
            "nullable":true
        },
        "pDescription":{
            "type":"string",
            "description":"Description of the new extract definition.",
            "nullable":true
        },
        "pDefinitionName":{
            "type":"string",
            "description":"Name of the extract definition created from the template.",
            "nullable":true
        },
        "pAdditionalDtls":{
            "type":"string",
            "description":"Additional details for the extract configuration.",
            "nullable":true
        }
    },
    "additionalProperties":false
}

Nested Schema : criteriaValues

Type: object

Additional Properties Allowed

Show Source

• array additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"array",
        "items":{
            "type":"string"
        }
    },
    "description":"Filter criteria values for the extract creation process.",
    "nullable":true
}

Filter criteria values for the extract creation process.

Nested Schema : extractObjects

Type: object

Additional Properties Allowed

Show Source

• object additionalProperties
  Additional Properties Allowed: additionalProperties

{
    "type":"object",
    "additionalProperties":{
        "type":"object",
        "additionalProperties":{
            "type":"string"
        }
    },
    "description":"Extract objects to include when creating the extract definition from the template.",
    "nullable":true
}

Extract objects to include when creating the extract definition from the template.

Nested Schema : additionalProperties

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

Nested Schema : additionalProperties

Type: object

Additional Properties Allowed

Show Source

• string

{
    "type":"object",
    "additionalProperties":{
        "type":"string"
    }
}

Back to Top

Response

Supported Media Types

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

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : schema

Type: object

Show Source

• result(required): number
  Result of the create extract definition operation.

{
    "required":[
        "result"
    ],
    "type":"object",
    "properties":{
        "result":{
            "type":"number",
            "description":"Result of the create extract definition operation."
        }
    },
    "additionalProperties":false
}

Back to Top