Copy a Template to a Folder
post
/api/restapi/document/templateCopy/sourceTemplate/{id}/targetFolder/{folderId}
Send a request to this endpoint to copy files and folders of a template to another folder with template ID given as a {id} path parameter and the target folder ID given as a {folderId} path parameter.
Request
Path Parameters
-
folderId(required): integer(int64)
The system-generated identifier of a folder.
-
id(required): integer(int64)
The system-generated identifier of a folder template.
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
201 Response
The object was successfully created.
Root Schema : ApiEntityDocument
Type:
object
Title:
Show Source
ApiEntityDocument
-
addressLine1: string
Maximum Length:
200
The first line of the address of a location.
This might be the building number and street address. -
addressLine2: string
Maximum Length:
200
The second line of the address associated with a file. -
annotationCount: object
annotationCount
The total number of annotations created for the file.
-
author: string
Maximum Length:
255
The system-generated identifier of a user assigned as an owner of this object. -
checkedOut: boolean
Indicates whether or not the file is checked-out.
-
checkedOutBy: string
Maximum Length:
255
The user that checked out a file. -
checkedOutDate: string
(date-time)
The date the user checked out the file.
-
checkedOutUserId: integer
(int64)
The system-generated identifier of a user.
-
cityName: string
Maximum Length:
200
The name of the city associated with a file. -
codeValuesDocument: array
codeValuesDocument
The list of code values for a file. This entity can only be used to assign codeValues or create codeValues on the fly.
-
comment: string
Maximum Length:
4000
Additional notes about the file. -
countryCode: string
Maximum Length:
3
The code of the country associated with a file. -
createDate: string
(date-time)
This field represent the date the record is created.
-
createUser: string
Maximum Length:
255
This field represent the user name of the user who created the record. -
description: string
Maximum Length:
4000
Additional information about the file. -
documentConfiguredFields: array
documentConfiguredFields
Unique Items Required:
true
The list of configured fields for a file. -
hasChildren: boolean
Indicates whether or not the folder has children.
-
id: string
Maximum Length:
18
The system-generated identifier of the file, folder, or template. -
isActualRoot: boolean
Indicates whether or not this folder is the root node in a folder structure.
-
latitude: number
(double)
The latitude of the location associated with the file.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
locationName: string
Maximum Length:
255
The name of the location associated with the file. -
longitude: number
(double)
The longitude of the location associated with the file.
-
mimeType: string
Maximum Length:
80
The type of a file. -
name: string
Maximum Length:
255
The name of the file, folder, or template. -
parentFolderPath: string
The path of the parent folder from it's root folder.
The field is non-persistable and thus maximum length is not applicable. -
parentId: string
Maximum Length:
18
The system-generated identifier of the parent object of the file or folder. -
parentType: string
Maximum Length:
60
The context in which the file is added. -
postalCode: string
Maximum Length:
20
The postal code of the location associated with the file. -
scanStatus: string
Allowed Values:
[ "SCAN_PENDING", "SCAN_CLEARED", "SCAN_FAILED", "SCAN_INCONCLUSIVE", "SCAN_ERROR", "SCAN_DISABLED" ]
Virus scan status of the current version of a file. A virus scan could return one of the following virus statuses:- SCAN_FAILED : A virus was found for this file.
- SCAN_CLEARED : Virus scan was run and found the file to not contain viruses.
- SCAN_DISABLED : File has not been scanned for viruses because scanning at has been disabled for the data center.
- SCAN_INCONCLUSIVE :Virus scan was run but was not able to provide a cleared status. Try to scan the file again, or contact Oracle support.
- SCAN_PENDING : Virus scan is in progress for this file.
- SCAN_ERROR : There was an error while scanning the file for viruses. Try to scan the file again.
-
scope: string
Allowed Values:
[ "genericPortfolio", "project", "template", "idea", "program", "strategy" ]
The object name of the context the file or folder is created in. -
scopeId: integer
(int64)
The system-generated identifier of the object of the context the file or folder is created in.
-
size: integer
(int64)
The current size of the file in bytes.
-
stateCode: string
Maximum Length:
2
The code of the state of the location associated with the file. -
stateName: string
Maximum Length:
200
The name of the state of the location associated with the file. -
type: string
Allowed Values:
[ "FOLDER", "DOCUMENT", "XLSX", "DOCX", "DOC", "XLS" ]
Indicates whether this is a file or a folder. -
updateDate: string
(date-time)
Date when the record was last updated.
-
updateUser: string
Maximum Length:
255
This field represent the user name of the user who last modified the record. -
url: string
The WebDAV URL for the file or folder.
It allows you to configure file management extensions to map an object to your machine.
Maximum Length: 2,147,483,647 -
version: string
Maximum Length:
255
The current version of the file. -
workspaceCode: string
Maximum Length:
60
The user-specified identifier of a workspace. -
workspaceId: integer
(int64)
The system-specified identifier of a workspace.
Nested Schema : annotationCount
Type:
object
The total number of annotations created for the file.
Nested Schema : codeValuesDocument
Type:
array
The list of code values for a file. This entity can only be used to assign codeValues or create codeValues on the fly.
Show Source
-
Array of:
object ApiEntityCodeValueDocument
Title:
ApiEntityCodeValueDocument
This entity represents a CodeValueDocument object, a unique CodeValueDocument object can be identified by the following combinations of the fields.- codeValueDocumentId
- codeValueId
- codeValueCode,codeTypeId
- codeValueCode,codeTypeCode
- codeValueCode,codeTypeCode,projectCode
Nested Schema : documentConfiguredFields
Type:
array
Unique Items Required:
true
The list of configured fields for a file.
Show Source
-
Array of:
object ApiEntityDocumentConfiguredFieldValue
Title:
ApiEntityDocumentConfiguredFieldValue
Nested Schema : ApiEntityCodeValueDocument
Type:
object
Title:
ApiEntityCodeValueDocument
This entity represents a CodeValueDocument object, a unique CodeValueDocument object can be identified by the following combinations of the fields.
Show Source
- codeValueDocumentId
- codeValueId
- codeValueCode,codeTypeId
- codeValueCode,codeTypeCode
- codeValueCode,codeTypeCode,projectCode
-
action: string
Allowed Values:
[ "DELETE" ]
Provide a value for this field during object update to delete code value assigned to the object. -
codeTypeCode: string
Minimum Length:
0
Maximum Length:60
This field displays the name of a code or value. -
codeTypeId(required): integer
(int64)
The unique identifier for the code type.The code type object can also be identified by its unique criteria.
-
codeTypeName: string
Minimum Length:
0
Maximum Length:255
The name of a code or value. -
codeValueCode(required): string
Minimum Length:
1
Maximum Length:60
The unique identifier for the code value. -
codeValueDocumentId: integer
(int64)
The system-generated identifier of a code value document assignment.
-
codeValueId: integer
(int64)
The unique identifier for the code value.
-
codeValueName: string
Minimum Length:
1
Maximum Length:255
The name of the code value. -
createDate: string
(date-time)
This field represent the date the record is created.
-
createUser: string
Maximum Length:
255
This field represent the user name of the user who created the record. -
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
parentId: integer
(int64)
The unique identifier of a parent code value.
-
projectCode: string
Minimum Length:
1
Maximum Length:60
The code of a Project of a Project CodeType. -
projectId: integer
(int64)
The unique identifier for the project.The project object can also be identified by its unique criteria.
-
sequenceNumber: integer
(int32)
The number that specifies the position of the code value item within the code type list.
-
updateDate: string
(date-time)
Date when the record was last updated.
-
updateUser: string
Maximum Length:
255
This field represent the user name of the user who last modified the record.
Nested Schema : ApiEntityDocumentConfiguredFieldValue
Type:
object
Title:
Show Source
ApiEntityDocumentConfiguredFieldValue
-
action: string
Allowed Values:
[ "DELETE" ]
Provide value for this field during object update to delete the assigned configured field value. -
columnDefinitionId: integer
(int64)
Unique identifier of the column. This value should not be provided in create operation request data, however, it is required for update requests.
-
columnLabel: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column label. -
columnName: string
Minimum Length:
1
Maximum Length:100
The user-specified UDF column name. -
costValue: number
This holds values for Cost type configured fields in the base currency conversion. Input should be provided in numberValue field, in currency of record.
-
costValueWorkspace1: number
(double)
This holds values for Cost type configured fields in the workspace1 currency conversion.
-
costValueWorkspace2: number
(double)
This holds values for Cost type configured fields in the workspace2 currency conversion.
-
costValueWorkspace3: number
(double)
This holds values for Cost type configured fields in the workspace3 currency conversion.
-
createDate: string
(date-time)
This field represent the date the record is created.
-
createUser: string
Maximum Length:
255
This field represent the user name of the user who created the record. -
dateValue: string
(date-time)
This holds values for Date type configured fields.
-
documentConfiguredFieldValueId: integer
(int64)
The unique identifier for the File Configured Field.
-
documentId: integer
(int64)
The system-generated identifier of the file, folder, or template.
-
link: string
(url)
The self-link to the object. This field is populated only in the responses generated by the batch create APIs.
-
numberValue: number
This holds values for Number, Integer and Cost type configured fields. Input for the cost configured field should be provided in the currency of record. For example project level currency in case of Activity, base currency for Company, workspace currency for Funds and record level currency for Project Actuals etc. configured fields.
-
textValue: string
Maximum Length:
255
This holds values for Boolean, List and Text type configured fields. -
updateDate: string
(date-time)
Date when the record was last updated.
-
updateUser: string
Maximum Length:
255
This field represent the user name of the user who last modified the record.
404 Response
The requested folder or template does not exist, or you do not have access to it.