Jump to

• Request
• Response

Copy Resource

post

/resource/copyResource

Copies a Resource structure and places it under a Resource Object specified by ParentResourceObjectId.

Request

Header Parameters

• Authorization: string
  OAuth token

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : CopyResource

Type: object

Title: CopyResource

CopyResource Entity

Show Source

• CopyChildResources: boolean
• CopyCodes: boolean
• CopyNotes: boolean
• CopyRoles: boolean
• CopyUDFs: boolean
• ParentResourceObjectId: string
  The unique identifier of an existing resource that will contain the copied Resource
• ResourceObjectId: string
  The unique identifier of the source Resource structure to copy.

{
    "title":"CopyResource",
    "type":"object",
    "properties":{
        "ResourceObjectId":{
            "type":"string",
            "description":"The unique identifier of the source Resource structure to copy.",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "ParentResourceObjectId":{
            "type":"string",
            "description":"The unique identifier of an existing resource that will contain the copied Resource",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        },
        "CopyChildResources":{
            "type":"boolean",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "CopyNotes":{
            "type":"boolean",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "CopyRoles":{
            "type":"boolean",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "CopyCodes":{
            "type":"boolean",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "CopyUDFs":{
            "type":"boolean",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        }
    },
    "description":"CopyResource Entity",
    "exampleSetFlag":false
}

Back to Top

Response

Supported Media Types

• application/json

201 Response

OK

Body ()

Root Schema : CopyResourceResponse

Type: object

Title: CopyResourceResponse

CopyResourceResponse Entity

Show Source

• ParentResourceObjectId: string
• ResourceObjectId: array ResourceObjectId
• Success: boolean

{
    "title":"CopyResourceResponse",
    "type":"object",
    "properties":{
        "Success":{
            "type":"boolean",
            "exampleSetFlag":false,
            "types":[
                "boolean"
            ]
        },
        "ResourceObjectId":{
            "type":"array",
            "exampleSetFlag":false,
            "items":{
                "type":"string",
                "exampleSetFlag":false,
                "types":[
                    "string"
                ]
            },
            "types":[
                "array"
            ]
        },
        "ParentResourceObjectId":{
            "type":"string",
            "exampleSetFlag":false,
            "types":[
                "string"
            ]
        }
    },
    "description":"CopyResourceResponse Entity",
    "exampleSetFlag":false
}

Nested Schema : ResourceObjectId

Type: array

Show Source

• Array of: string

{
    "type":"array",
    "exampleSetFlag":false,
    "items":{
        "type":"string",
        "exampleSetFlag":false,
        "types":[
            "string"
        ]
    },
    "types":[
        "array"
    ]
}

400 Response

Bad Request.

401 Response

Unauthorized.

403 Response

Forbidden.

404 Response

Not Found.

405 Response

Invalid Input.

500 Response

Internal Server Error.

Back to Top