--- title: "Duplicate a report runner" method: POST path: "/v7/report-runners/{reportRunnerId}/duplicate" tags: ["Report Schedules"] --- # Duplicate a report runner `POST /v7/report-runners/{reportRunnerId}/duplicate` Creates a new report runner by duplicating the supplied one. The body provides the overrides to apply to the copy; fields absent from the body are copied from the source. Set `allow_duplicate=true` to allow creating a runner with the same name as an existing one. Returns the new report runner. ## Path parameters - `reportRunnerId` string, required ## Query parameters - `allow_duplicate` boolean, nullable ## Request body - union — Body of a `PUT /v7/report-runners/{reportRunnerId}` request. - object - `component_ids` string[] - `component_references` ComponentReferenceRequest[] - `component_id` string - `socket_names` string[] - `deliver_empty_reports_to_sftp` boolean, nullable - `enabled` boolean - `execution_policy` 'AWAIT_DATA' | 'IMMEDIATE' - `formats` string[] - `merging_configuration` MergingConfigurationRequest - `deliverable_type` string - `formats` string[] - `sort_by` string[] - `unique_by` string[] - `name` string - `parameters` object - `pause_info` PauseInfoRequest - `description` string, nullable - `paused` boolean - `report_name_pattern` union — Choose between static or dynamic report name pattern - string — Handlebars expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). - string — Javascript expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). - `report_type` string - `scopes` string[] - `sftp_report_name_pattern` union — Choose between static or dynamic sftp report name pattern - string — Handlebars expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). - string — Javascript expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). - `sftp_server_id` string, nullable - `tags` string[] - `type` 'REFRESHING', required - `expiration_ms` integer - object - `component_ids` string[] - `component_references` ComponentReferenceRequest[] - `component_id` string - `socket_names` string[] - `deliver_empty_reports_to_sftp` boolean, nullable - `enabled` boolean - `execution_policy` 'AWAIT_DATA' | 'IMMEDIATE' - `formats` string[] - `merging_configuration` MergingConfigurationRequest - `deliverable_type` string - `formats` string[] - `sort_by` string[] - `unique_by` string[] - `name` string - `parameters` object - `pause_info` PauseInfoRequest - `description` string, nullable - `paused` boolean - `report_name_pattern` union — Choose between static or dynamic report name pattern - string — Handlebars expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). - string — Javascript expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). - `report_type` string - `scopes` string[] - `sftp_report_name_pattern` union — Choose between static or dynamic sftp report name pattern - string — Handlebars expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). - string — Javascript expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). - `sftp_server_id` string, nullable - `tags` string[] - `type` 'SCHEDULED', required - `frequency` 'DAILY' | 'HOURLY' | 'LOGIN' | 'MONTHLY' | 'QUARTERLY' | 'WEEKLY' - `legacy_sftp_report_name_format` boolean - `schedule_start_date` string — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. ## Response `200` Duplicated report runner. - union - object - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `deliver_empty_reports_to_sftp` boolean, required - `enabled` boolean, required - `execution_policy` 'AWAIT_DATA' | 'IMMEDIATE', required - `formats` string[], required - `id` string, required - `merging_configuration` MergingConfigurationResponse, required - `deliverable_type` 'ACCUMULATING' | 'INDIVIDUAL' | 'NEW_ENTRIES' - `formats` string[] - `sort_by` string[] - `unique_by` string[] - `name` string, required - `parameters` object, required - `pause_info` PauseInfoResponse, required - `description` string - `updated_date` string — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) UTC date-time with a `Z` suffix. Precision up to milliseconds. - `user_id` string - `paused` PauseInfoResponse, required - `description` string - `updated_date` string — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) UTC date-time with a `Z` suffix. Precision up to milliseconds. - `user_id` string - `report_name_pattern` union, required — The report name pattern as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). - string — Javascript expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). - `report_type` string, required - `report_type_name` string, required - `scopes` string[], required - `sftp_report_name_pattern` union, required — The sftp report name pattern as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). - string — Javascript expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). - `sftp_server_id` string, nullable, required - `tags` string[], required - `type` 'REFRESHING', required - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `user_id` string, required - `expiration_ms` integer, required - object - `component_ids` string[], required - `component_references` ComponentReferenceResponse[], required - `component_id` string - `socket_names` string[] - `created_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `deliver_empty_reports_to_sftp` boolean, required - `enabled` boolean, required - `execution_policy` 'AWAIT_DATA' | 'IMMEDIATE', required - `formats` string[], required - `id` string, required - `merging_configuration` MergingConfigurationResponse, required - `deliverable_type` 'ACCUMULATING' | 'INDIVIDUAL' | 'NEW_ENTRIES' - `formats` string[] - `sort_by` string[] - `unique_by` string[] - `name` string, required - `parameters` object, required - `pause_info` PauseInfoResponse, required - `description` string - `updated_date` string — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) UTC date-time with a `Z` suffix. Precision up to milliseconds. - `user_id` string - `paused` PauseInfoResponse, required - `description` string - `updated_date` string — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) UTC date-time with a `Z` suffix. Precision up to milliseconds. - `user_id` string - `report_name_pattern` union, required — The report name pattern as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). - string — Javascript expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). - `report_type` string, required - `report_type_name` string, required - `scopes` string[], required - `sftp_report_name_pattern` union, required — The sftp report name pattern as configured: a literal value, or an expression (type:string) when defined dynamically. - string — Handlebars expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). - string — Javascript expression with [ReportRunnerExecutionContext](https://github.com/extole/extole-specification/blob/main/openapi/expression-context/com/extole/api/report_runner/ReportRunnerExecutionContext.d.ts). - `sftp_server_id` string, nullable, required - `tags` string[], required - `type` 'SCHEDULED', required - `updated_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. - `user_id` string, required - `frequency` 'DAILY' | 'HOURLY' | 'LOGIN' | 'MONTHLY' | 'QUARTERLY' | 'WEEKLY', required - `legacy_sftp_report_name_format` boolean, required - `schedule_start_date` string, required — [RFC 3339](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) or [RFC 9557](https://datatracker.ietf.org/doc/html/rfc9557#section-4) date-time with a numeric [UTC offset](https://datatracker.ietf.org/doc/html/rfc3339#section-5.6) and an optional [IANA time-zone](https://datatracker.ietf.org/doc/html/rfc9557#section-4) suffix in square brackets. Precision up to milliseconds. ## Other responses - `400` — Validation failed. The named examples below cover this operation's most common rejections; other 400 causes are auto-derived from the request body - inspect the response `code` field for the specific error. - `401` — Unauthorized - `402` — Payment Required - `403` — Forbidden - `404` — Report runner was not found. The supplied id does not match any report runner accessible to the calling client. - `415` — Unsupported Media Type - `429` — Too Many Requests --- [API](https://skmtc.net/extole/apis/integration-api-server-to-extole.md) · [All operations](https://skmtc.net/extole/apis/integration-api-server-to-extole/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/extole/integration-api-server-to-extole/versions/c16e62e66755/schema)