Jump to

• Request
• Response

Copy rules in bulk

put

/ec-rule-designer-svc/rest/v3.0/rule/studies/{studyId}/bulkcopy

Copy rules in bulk.

Request

Path Parameters

• studyId(required): string(uuid)
  Study Id

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• studies: array studies

{
    "type":"object",
    "properties":{
        "studies":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/StudyMapDTOV3"
            }
        }
    }
}

Nested Schema : studies

Type: array

Show Source

• Array of: object schema

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/StudyMapDTOV3"
    }
}

Nested Schema : schema

Type: object

Show Source

• forms: array forms
• fromIsLibrary: boolean
• fromStudyId: string (uuid)
• fromStudyVersion: string
• isToIsLibrary: boolean
• toIsLibrary: boolean
• toStudyId: string (uuid)
• toStudyVersion: string

{
    "type":"object",
    "properties":{
        "forms":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/FormMapDTO"
            }
        },
        "isToIsLibrary":{
            "type":"boolean"
        },
        "fromStudyId":{
            "type":"string",
            "format":"uuid"
        },
        "fromStudyVersion":{
            "type":"string"
        },
        "fromIsLibrary":{
            "type":"boolean"
        },
        "toStudyId":{
            "type":"string",
            "format":"uuid"
        },
        "toStudyVersion":{
            "type":"string"
        },
        "toIsLibrary":{
            "type":"boolean"
        }
    }
}

Nested Schema : forms

Type: array

Show Source

• Array of: object FormMapDTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/FormMapDTO"
    }
}

Nested Schema : FormMapDTO

Type: object

Show Source

• fromFormId: string (uuid)
• fromFormRefName: string
• items: array items
• toFormId: string (uuid)
• toFormRefName: string

{
    "type":"object",
    "properties":{
        "fromFormId":{
            "type":"string",
            "format":"uuid"
        },
        "fromFormRefName":{
            "type":"string"
        },
        "toFormId":{
            "type":"string",
            "format":"uuid"
        },
        "toFormRefName":{
            "type":"string"
        },
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ItemMapDTO"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ItemMapDTO

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/ItemMapDTO"
    }
}

Nested Schema : ItemMapDTO

Type: object

Show Source

• fromItemId: string (uuid)
• fromItemRefName: string
• toItemId: string (uuid)
• toItemRefName: string

{
    "type":"object",
    "properties":{
        "fromItemId":{
            "type":"string",
            "format":"uuid"
        },
        "fromItemRefName":{
            "type":"string"
        },
        "toItemId":{
            "type":"string",
            "format":"uuid"
        },
        "toItemRefName":{
            "type":"string"
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

200 Response

Bulk delete rules was successful.

Body ()

Root Schema : RDSRestUnifiedResponseDTO

Type: object

Error details from Rule Designer APIs for bulk operations

Show Source

• error: object RDSRestErrorDataDTO
  Read Only: true

  Error details from Rule Designer APIs
• httpErrorCode: integer (int32)
  Read Only: true

  Http Error Code
• httpErrorMessage: string
  Read Only: true

  Http Error Message
• jobId: string (uuid)
  Read Only: true

  Job Id
• jobStatus: string
  Read Only: true

  Job Status
• result: object RDSRestResponseDTO
  Read Only: true

  Response from Rule Designer APIs
• Rule Validation Message: string
  Read Only: true

  Rule Validation Message
• Rule Validation Status: boolean
  Read Only: true

  Rule Validation State
• ruleId: string (uuid)
  Read Only: true

  Rule Id
• ruleName: string
  Read Only: true

  Rule Name

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Rule Id",
            "format":"uuid",
            "readOnly":true
        },
        "ruleName":{
            "type":"string",
            "description":"Rule Name",
            "readOnly":true
        },
        "jobId":{
            "type":"string",
            "description":"Job Id",
            "format":"uuid",
            "readOnly":true
        },
        "jobStatus":{
            "type":"string",
            "description":"Job Status",
            "readOnly":true
        },
        "Rule Validation Message":{
            "type":"string",
            "description":"Rule Validation Message",
            "readOnly":true
        },
        "Rule Validation Status":{
            "type":"boolean",
            "description":"Rule Validation State",
            "readOnly":true
        },
        "result":{
            "$ref":"#/components/schemas/RDSRestResponseDTO"
        },
        "error":{
            "$ref":"#/components/schemas/RDSRestErrorDataDTO"
        },
        "httpErrorCode":{
            "type":"integer",
            "description":"Http Error Code",
            "format":"int32",
            "readOnly":true
        },
        "httpErrorMessage":{
            "type":"string",
            "description":"Http Error Message",
            "readOnly":true
        }
    },
    "description":"Error details from Rule Designer APIs for bulk operations"
}

Nested Schema : RDSRestErrorDataDTO

Type: object

Read Only: true

Error details from Rule Designer APIs

Show Source

• details: object details
  Read Only: true

  Error Details
• errorCode: string
  Read Only: true

  Error Code
• errorMessage: string
  Read Only: true

  Error Message
• result: string
  Read Only: true

  Result
• status: string
  Read Only: true

  Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true
        },
        "result":{
            "type":"string",
            "description":"Result",
            "readOnly":true
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Rule Designer APIs",
    "readOnly":true
}

Nested Schema : RDSRestResponseDTO

Type: object

Read Only: true

Response from Rule Designer APIs

Show Source

• result: object result
  Read Only: true

  Result Object
• status: string
  Read Only: true

  Allowed Values: [ "success, failed" ]

  Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result Object",
            "readOnly":true
        }
    },
    "description":"Response from Rule Designer APIs",
    "readOnly":true
}

Nested Schema : details

Type: object

Read Only: true

Error Details

Nested Schema : result

Type: object

Read Only: true

Result Object

400 Response

Incorrect payload.

Body ()

Root Schema : RDSRestUnifiedResponseDTO

Type: object

Error details from Rule Designer APIs for bulk operations

Show Source

• error: object RDSRestErrorDataDTO
  Read Only: true

  Error details from Rule Designer APIs
• httpErrorCode: integer (int32)
  Read Only: true

  Http Error Code
• httpErrorMessage: string
  Read Only: true

  Http Error Message
• jobId: string (uuid)
  Read Only: true

  Job Id
• jobStatus: string
  Read Only: true

  Job Status
• result: object RDSRestResponseDTO
  Read Only: true

  Response from Rule Designer APIs
• Rule Validation Message: string
  Read Only: true

  Rule Validation Message
• Rule Validation Status: boolean
  Read Only: true

  Rule Validation State
• ruleId: string (uuid)
  Read Only: true

  Rule Id
• ruleName: string
  Read Only: true

  Rule Name

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Rule Id",
            "format":"uuid",
            "readOnly":true
        },
        "ruleName":{
            "type":"string",
            "description":"Rule Name",
            "readOnly":true
        },
        "jobId":{
            "type":"string",
            "description":"Job Id",
            "format":"uuid",
            "readOnly":true
        },
        "jobStatus":{
            "type":"string",
            "description":"Job Status",
            "readOnly":true
        },
        "Rule Validation Message":{
            "type":"string",
            "description":"Rule Validation Message",
            "readOnly":true
        },
        "Rule Validation Status":{
            "type":"boolean",
            "description":"Rule Validation State",
            "readOnly":true
        },
        "result":{
            "$ref":"#/components/schemas/RDSRestResponseDTO"
        },
        "error":{
            "$ref":"#/components/schemas/RDSRestErrorDataDTO"
        },
        "httpErrorCode":{
            "type":"integer",
            "description":"Http Error Code",
            "format":"int32",
            "readOnly":true
        },
        "httpErrorMessage":{
            "type":"string",
            "description":"Http Error Message",
            "readOnly":true
        }
    },
    "description":"Error details from Rule Designer APIs for bulk operations"
}

Nested Schema : RDSRestErrorDataDTO

Type: object

Read Only: true

Error details from Rule Designer APIs

Show Source

• details: object details
  Read Only: true

  Error Details
• errorCode: string
  Read Only: true

  Error Code
• errorMessage: string
  Read Only: true

  Error Message
• result: string
  Read Only: true

  Result
• status: string
  Read Only: true

  Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true
        },
        "result":{
            "type":"string",
            "description":"Result",
            "readOnly":true
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Rule Designer APIs",
    "readOnly":true
}

Nested Schema : RDSRestResponseDTO

Type: object

Read Only: true

Response from Rule Designer APIs

Show Source

• result: object result
  Read Only: true

  Result Object
• status: string
  Read Only: true

  Allowed Values: [ "success, failed" ]

  Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result Object",
            "readOnly":true
        }
    },
    "description":"Response from Rule Designer APIs",
    "readOnly":true
}

Nested Schema : details

Type: object

Read Only: true

Error Details

Nested Schema : result

Type: object

Read Only: true

Result Object

500 Response

An internal error occured.

Body ()

Root Schema : RDSRestUnifiedResponseDTO

Type: object

Error details from Rule Designer APIs for bulk operations

Show Source

• error: object RDSRestErrorDataDTO
  Read Only: true

  Error details from Rule Designer APIs
• httpErrorCode: integer (int32)
  Read Only: true

  Http Error Code
• httpErrorMessage: string
  Read Only: true

  Http Error Message
• jobId: string (uuid)
  Read Only: true

  Job Id
• jobStatus: string
  Read Only: true

  Job Status
• result: object RDSRestResponseDTO
  Read Only: true

  Response from Rule Designer APIs
• Rule Validation Message: string
  Read Only: true

  Rule Validation Message
• Rule Validation Status: boolean
  Read Only: true

  Rule Validation State
• ruleId: string (uuid)
  Read Only: true

  Rule Id
• ruleName: string
  Read Only: true

  Rule Name

{
    "type":"object",
    "properties":{
        "ruleId":{
            "type":"string",
            "description":"Rule Id",
            "format":"uuid",
            "readOnly":true
        },
        "ruleName":{
            "type":"string",
            "description":"Rule Name",
            "readOnly":true
        },
        "jobId":{
            "type":"string",
            "description":"Job Id",
            "format":"uuid",
            "readOnly":true
        },
        "jobStatus":{
            "type":"string",
            "description":"Job Status",
            "readOnly":true
        },
        "Rule Validation Message":{
            "type":"string",
            "description":"Rule Validation Message",
            "readOnly":true
        },
        "Rule Validation Status":{
            "type":"boolean",
            "description":"Rule Validation State",
            "readOnly":true
        },
        "result":{
            "$ref":"#/components/schemas/RDSRestResponseDTO"
        },
        "error":{
            "$ref":"#/components/schemas/RDSRestErrorDataDTO"
        },
        "httpErrorCode":{
            "type":"integer",
            "description":"Http Error Code",
            "format":"int32",
            "readOnly":true
        },
        "httpErrorMessage":{
            "type":"string",
            "description":"Http Error Message",
            "readOnly":true
        }
    },
    "description":"Error details from Rule Designer APIs for bulk operations"
}

Nested Schema : RDSRestErrorDataDTO

Type: object

Read Only: true

Error details from Rule Designer APIs

Show Source

• details: object details
  Read Only: true

  Error Details
• errorCode: string
  Read Only: true

  Error Code
• errorMessage: string
  Read Only: true

  Error Message
• result: string
  Read Only: true

  Result
• status: string
  Read Only: true

  Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true
        },
        "result":{
            "type":"string",
            "description":"Result",
            "readOnly":true
        },
        "errorCode":{
            "type":"string",
            "description":"Error Code",
            "readOnly":true
        },
        "errorMessage":{
            "type":"string",
            "description":"Error Message",
            "readOnly":true
        },
        "details":{
            "type":"object",
            "description":"Error Details",
            "readOnly":true
        }
    },
    "description":"Error details from Rule Designer APIs",
    "readOnly":true
}

Nested Schema : RDSRestResponseDTO

Type: object

Read Only: true

Response from Rule Designer APIs

Show Source

• result: object result
  Read Only: true

  Result Object
• status: string
  Read Only: true

  Allowed Values: [ "success, failed" ]

  Status

{
    "type":"object",
    "properties":{
        "status":{
            "type":"string",
            "description":"Status",
            "readOnly":true,
            "enum":[
                "success, failed"
            ]
        },
        "result":{
            "type":"object",
            "description":"Result Object",
            "readOnly":true
        }
    },
    "description":"Response from Rule Designer APIs",
    "readOnly":true
}

Nested Schema : details

Type: object

Read Only: true

Error Details

Nested Schema : result

Type: object

Read Only: true

Result Object

Back to Top