User Manual

08.14.2024

MANUAL

Developer Function: API: Site Operation: Copy Site

## Overview You can update site settings using the API. ## Supported Versions Pleasanter 1.2.2.8 and later ## Limitations 1. Only due date tables and record tables can be used. ## Preparation Please [Create an API Key](/manual/api-key) before performing API operations. Also, this function can only be performed by the tenant administrator, so please set up the tenant administrator from user management. ## Request Send json data in the following request format: |Setting item|Value| |:--|:--| |HTTP Method|POST| |Content-Type |application/json| |Character Code|UTF-8| |URL|http://{server name}/api/items/{site ID}/copysitepackage (*1)| |Body|Refer to the json data below| (*1) Please edit the {server name} and {site ID} parts to suit your environment as appropriate. For pleasanter.net, the format is as follows: https\://pleasanter.net/fs/api/items/{site ID}/copysitepackage For {site ID}, specify the site ID of the site to be copied whose title is to be updated. ##### JSON ``` { "ApiVersion": "1.1", "ApiKey": "345yuAjA6789dA09d8uj6...", "TargetSiteId": 466220, "SiteTitle": "test", "SelectedSites": [ { "SiteId": 466217 }, { "SiteId": 466218, "IncludeData": false } ], "IncludeSitePermission": false, "IncludeRecordPermission": true, "IncludeColumnPermission": false, "IncludeNotifications": true, "IncludeReminders": true } ``` |Column|Settings| |:--|:--| |TargetSiteId|Specify the site ID of the destination folder. If omitted, it will be copied to the top screen. | |SiteTitle|Specify the title of the site written in the {site ID} of the URL. Use this when changing the site title. | |SelectedSites|Specify the sites to copy. When writing, set the same value as the "Convertors" parameter when exporting the site package. | *For the parameters after IncludeSitePermission, please set the same value as the "HeaderInfo" parameter when exporting the site package. ## Response The json data in the following format will be returned. ##### JSON ``` { "StatusCode": 200, "Response": { "Data": "[ {\"OldSiteId\":466217,\"NewSiteId\":466221,\"ReferenceType\":\"Sites\",\"Title\":\"test\"}, {\"OldSiteId\":466218,\"NewSiteId\":466222,\"ReferenceType\":\"Results\",\"Title\":\"Record Table\"} ]" } } ```
TOP
このページをシェアする
記載された商品名、各製品名は各社の登録商標または商標です。 © Implem Inc.