Retrieve Site

2022-04-152026-09-11

Overview¶

You can use the API to get site information.

Supported Versions¶

Pleasanter 1.3.4.0 and later

Limitations¶

Wiki is not supported.

Preparations¶

Please Create an API Key before performing API operations. Also, this function can only be performed by the tenant manager, so please set up the tenant manager from user management.

Request¶

Send json data in the following request format:

Setting column	Value
HTTP Method	POST
Content-Type	application/json
Character Code	UTF-8
URL	http://{server name}/api/items/{site ID}/getsite (*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}/getsite
For {site ID}, specify the site ID to be retrieved.

JSON¶

{
    "ApiVersion": "1.1",
    "ApiKey": "345yuAjA6789dA09d8uj6..."
}

Response¶

The following JSON data will be returned:

JSON¶

{
    "StatusCode": 200,
    "Response": {
        "Data": {
            "TenantId": 1,
            "SiteId": 12345,
            "UpdatedTime": "2023-08-17T12:00:00",
            "Ver": 1,
            "Title": "Recorded Table",
            "Body": "",
            "SiteName": "",
            "SiteGroupName": "",
            "GridGuide": "",
            "EditorGuide": "",
            "CalendarGuide": "",
            "CrosstabGuide": "",
            "GanttGuide": "",
            "BurnDownGuide": "",
            "TimeSeriesGuide": "",
            "KambanGuide": "",
            "ImageLibGuide": "",
            "ReferenceType": "Results",
            "ParentId": 12344,
            "InheritPermission": 3301,
            "Permissions": [
            ],
            "SiteSettings": {
                "Version": 1.017,
                "ReferenceType": "Results",
                "EditorColumnHash": {
                    "General": [
                        "ResultId",
                        "Ver",
                        "Title",
                        "Body",
                        "Status",
                        "Manager",
                        "Owner",
                        "Comments",
                        "ClassA",
                        "ClassB",
                        "ClassC"
                    ]
                },
                "NoDisplayIfReadOnly": false
            },
            "Publish": false,
            "DisableCrossSearch": false,
            "LockedTime": "1899-12-30T00:00:00",
            "LockedUser": 0,
            "ApiCountDate": "1899-12-30T00:00:00",
            "ApiCount": 0,
            "Comments": "[]",
            "Creator": 1,
            "Updator": 1,
            "CreatedTime": "2023-08-17T09:00:00",
            "ApiVersion": 1.1,
            "ClassHash": {
            },
            "NumHash": {
            },
            "DateHash": {
            },
            "DescriptionHash": {
            },
            "CheckHash": {
            },
            "AttachmentsHash": {
            }
        }
    }
}