Title Command Reference

📌 Tips

PGOS provides two sets of CLI commands, one is the command of the PGOS title region, and the other is the command of the PGOS title global. The content displayed in the current file is the command of the PGOS title global.

If you use the CLI HTTP API method to use, please use the Title CLI API Domain to access.

If you use the CLI Tools, please upgrade to at least version 0.2.11 for use.

Title File Interface

list-title-file

cli-load-json

{}

output

{
  "List": [
    {
      "ID": "the id of the title file, type is number",
      "TitleID": "the title id of the pgos, type is string",
      "ParentID": "the parent id of the title file, only root folder is null, type is number",
      "Name": "the name of the title file, type is string",
      "Status": "the status of the title file, options: Enable, Disable, type is string",
      "Type": "the type of the title file, options: File, Dir, type is string",
      "MD5": "the md5 of the title file, type is string",
      "Size": "the size of the title file, type is number",
      "Tags": "the tags of the title file, type is array string",
      "ServerOnly": "whether the title file is server only, options: 'True', 'False', default is 'False', only for file, type is string",
      "Operator": "the last operator of the title file, type is string",
      "CreatedTime": "the created time of the title file, type is string, use ISO 8601 date format",
      "UpdatedTime": "the updated time of the title file, type is string, use ISO 8601 date format"
    }
  ],
  "Root": {
    "ID": "the id of the title file, type is number",
    "TitleID": "the title id of the pgos, type is string",
    "ParentID": "the parent id of the title file, only root folder is null, type is number",
    "Name": "the name of the title file, type is string",
    "Status": "the status of the title file, options: Enable, Disable, type is string",
    "Type": "the type of the title file, options: File, Dir, type is string",
    "MD5": "the md5 of the title file, type is string",
    "Size": "the size of the title file, type is number",
    "Tags": "the tags of the title file, type is array string",
    "ServerOnly": "whether the title file is server only, options: 'True', 'False', default is 'False', only for file, type is string",
    "Operator": "the last operator of the title file, type is string",
    "CreatedTime": "the created time of the title file, type is string, use ISO 8601 date format",
    "UpdatedTime": "the updated time of the title file, type is string, use ISO 8601 date format"
  },
  "Tree": {
    "ID": "the id of the the title file, type is number",
    "Name": "the name of the the title file, type is string",
    "Status": "the status of the the title file, options: Enable, Disable, type is string",
    "Type": "the type of the title file, options: File, Dir, type is string",
    "Children": "the children of the the title file, type is array",
    "Metadata": {
      "ParentID": "the parent id of the the title file, only root folder is null, type is number",
      "Operator": "the last operator of the the title file, type is string",
      "MD5": "the md5 of the the title file, type is string",
      "Size": "the size of the the title file, type is number",
      "Tags": "the tags of the the title file, type is array string",
      "ServerOnly": "whether the title file is server only, options: 'True', 'False', default is 'False', only for file, type is string",
      "CreatedTime": "the created time of the the title file, type is string, use ISO 8601 date format",
      "UpdatedTime": "the updated time of the the title file, type is string, use ISO 8601 date format"
    }
  },
  "ID2Path": "the id to path map, type is object",
  "Path2ID": "the path to id map, type is object",
  "Total": "the total number of title files, type is number"
}

✨️ Request Example

{}

create-title-file

cli-load-json

{
  "ParentID": "required, the parent id of the title file. you can use ParentID or ParentPath to specify the parent folder, if both are specified, ParentID is preferred, type is number",
  "ParentPath": "required, the parent path of the title file, example: \"/Folder001\". you can use ParentID or ParentPath to specify the parent folder, if both are specified, ParentID is preferred, type is string",
  "Name": "required, the name of the title file, type is string, must equal to the file name",
  "MD5": "required, the md5 of the title file, type is string",
  "Size": "required, the size of the title file, type is number",
  "ServerOnly": "whether the title file is server only, options: 'True', 'False', default is 'False', only for file, type is string"
}

cli-upload-files

{
  "path": "the path of the file to upload, type is string",
  "label": "the label of the file to upload, must be \"FilePath\" in title file request, type is string"
}

output

{
  "ID": "the id of the title file, type is number",
  "TitleID": "the title id of the pgos, type is string",
  "ParentID": "the parent id of the title file, only root folder is null, type is number",
  "Name": "the name of the title file, type is string",
  "Status": "the status of the title file, options: Enable, Disable, type is string",
  "Type": "the type of the title file, options: File, Dir, type is string",
  "MD5": "the md5 of the title file, type is string",
  "Size": "the size of the title file, type is number",
  "Tags": "the tags of the title file, type is array string",
  "ServerOnly": "whether the title file is server only, options: 'True', 'False', default is 'False', only for file, type is string",
  "Operator": "the last operator of the title file, type is string",
  "CreatedTime": "the created time of the title file, type is string, use ISO 8601 date format",
  "UpdatedTime": "the updated time of the title file, type is string, use ISO 8601 date format"
}

✨️ Request Example

{
  "ParentID": null,
  "ParentPath": "/Folder001",
  "Name": "1.jpg",
  "MD5": "xxxx",
  "Size": 100
}

delete-title-file

cli-load-json

{
  "TitleFileID": "required, the id of the title file. you can use TitleFileID or TitleFilePath to specify the title file, if both are specified, TitleFileID is preferred, type is number",
  "TitleFilePath": "required, the path of the title file, example: \"/Folder001/TitleFile001\". you can use TitleFileID or TitleFilePath to specify the title file, if both are specified, TitleFileID is preferred, type is string"
}

output

{}

✨️ Request Example

{
  "TitleFileID": null,
  "TitleFilePath": "/Folder001/1.jpg"
}

describe-title-file

cli-load-json

{
  "TitleFileID": "required, the id of the title file. you can use TitleFileID or TitleFilePath to specify the title file, if both are specified, TitleFileID is preferred, type is number",
  "TitleFilePath": "required, the path of the title file, example: \"/Folder001/TitleFile001\". you can use TitleFileID or TitleFilePath to specify the title file, if both are specified, TitleFileID is preferred, type is string"
}

output

{
  "ID": "the id of the title file, type is number",
  "TitleID": "the title id of the pgos, type is string",
  "ParentID": "the parent id of the title file, only root folder is null, type is number",
  "Name": "the name of the title file, type is string",
  "Status": "the status of the title file, options: Enable, Disable, type is string",
  "Type": "the type of the title file, options: File, Dir, type is string",
  "MD5": "the md5 of the title file, type is string",
  "Size": "the size of the title file, type is number",
  "Tags": "the tags of the title file, type is array string",
  "ServerOnly": "whether the title file is server only, options: 'True', 'False', default is 'False', only for file, type is string",
  "Operator": "the last operator of the title file, type is string",
  "CreatedTime": "the created time of the title file, type is string, use ISO 8601 date format",
  "UpdatedTime": "the updated time of the title file, type is string, use ISO 8601 date format"
}

✨️ Request Example

{
  "TitleFileID": 10001,
  "TitleFilePath": "/Folder001/xxxx.jpg"
}

create-title-file-folder

cli-load-json

{
  "ParentID": "required, the parent id of the title file. you can use ParentID or ParentPath to specify the parent folder, if both are specified, ParentID is preferred, type is number",
  "ParentPath": "required, the parent path of the title file, example: \"/Folder001\". you can use ParentID or ParentPath to specify the parent folder, if both are specified, ParentID is preferred, type is string",
  "Name": "required, the name of the title file, type is string, must equal to the file name"
}

output

{
  "ID": "the id of the title file, type is number",
  "TitleID": "the title id of the pgos, type is string",
  "ParentID": "the parent id of the title file, only root folder is null, type is number",
  "Name": "the name of the title file, type is string",
  "Status": "the status of the title file, options: Enable, Disable, type is string",
  "Type": "the type of the title file, options: File, Dir, type is string",
  "MD5": "the md5 of the title file, type is string",
  "Size": "the size of the title file, type is number",
  "Tags": "the tags of the title file, type is array string",
  "Operator": "the last operator of the title file, type is string",
  "CreatedTime": "the created time of the title file, type is string, use ISO 8601 date format",
  "UpdatedTime": "the updated time of the title file, type is string, use ISO 8601 date format"
}

✨️ Request Example

{
  "ParentID": null,
  "ParentPath": "/Folder001",
  "Name": "xxxxx1"
}

delete-title-file-folder

cli-load-json

{
  "TitleFileID": "required, the id of the title file. you can use TitleFileID or TitleFilePath to specify the title file, if both are specified, TitleFileID is preferred, type is number",
  "TitleFilePath": "required, the path of the title file, example: \"/Folder001/TitleFile001\". you can use TitleFileID or TitleFilePath to specify the title file, if both are specified, TitleFileID is preferred, type is string"
}

output

{}

✨️ Request Example

{
  "TitleFileID": null,
  "TitleFilePath": "/Folder001/xxxxx1"
}

refresh-title-file-cache

cli-load-json

{}

output

{}

✨️ Request Example

{}

Title Config Data Interface

list-title-config-data

cli-load-json

{}

output

{
  "List": [
    {
      "ID": "the id of the title config data, type is number",
      "TitleID": "the title id of the title config data, type is string",
      "Key": "the key of the title config data, type is string",
      "Value": "the value of the title config data, type is string",
      "Description": "the description of the title config data, type is string",
      "ServerOnly": "the permission of the title config data, options: True, False, type is string",
      "IsJson": "the type of the title config data, options: True, False, type is string",
      "Order": "the order of the title config data, type is number",
      "CreatedTime": "the created time of the title config data, type is string, use ISO 8601 date format",
      "UpdatedTime": "the updated time of the title config data, type is string, use ISO 8601 date format"
    }
  ],
  "Total": "the total number of title config datas, type is number"
}

✨️ Request Example

{}

create-title-config-data

cli-load-json

{
  "Key": "required, the key of the title config data, type is string",
  "Value": "required, the value of the title config data, type is string",
  "Description": "the description of the title config data, type is string",
  "ServerOnly": "required, the permission of the title config data, options: True, False, type is string",
  "IsJson": "required, the type of the title config data, options: True, False, type is string"
}

output

{
  "ID": "the id of the title config data, type is number",
  "TitleID": "the title id of the pgos, type is string",
  "Key": "the key of the title config data, type is string",
  "Value": "the value of the title config data, type is string",
  "Description": "the description of the title config data, type is string",
  "ServerOnly": "the permission of the title config data, options: True, False, type is string",
  "IsJson": "the type of the title config data, options: True, False, type is string",
  "Order": "the order of the title config data, type is number",
  "CreatedTime": "the created time of the title config data, type is string, use ISO 8601 date format",
  "UpdatedTime": "the updated time of the title config data, type is string, use ISO 8601 date format"
}

✨️ Request Example

{
  "Key": "test001",
  "Value": "test",
  "Description": "test",
  "ServerOnly": "True",
  "IsJson": "True"
}

update-title-config-data

cli-load-json

{
  "Key": "required, the key of the title config data, type is string",
  "Value": "required, the value of the title config data, type is string",
  "Description": "the description of the title config data, type is string",
  "ServerOnly": "required, the permission of the title config data, options: True, False, type is string",
  "IsJson": "required, the type of the title config data, options: True, False, type is string"
}

output

{}

✨️ Request Example

{
  "Key": "test001",
  "Value": "test",
  "Description": "test",
  "ServerOnly": "True",
  "IsJson": "True"
}

delete-title-config-data

cli-load-json

{
  "Key": "required, the key of the title config data, type is string"
}

output

{}

✨️ Request Example

{
  "Key": "xxxx"
}

describe-title-config-data

cli-load-json

{
  "Key": "required, the key of the title config data, type is string"
}

output

{
  "ID": "the id of the title config data, type is number",
  "TitleID": "the title id of the pgos, type is string",
  "Key": "the key of the title config data, type is string",
  "Value": "the value of the title config data, type is string",
  "Description": "the description of the title config data, type is string",
  "ServerOnly": "the permission of the title config data, options: True, False, type is string",
  "IsJson": "the type of the title config data, options: True, False, type is string",
  "Order": "the order of the title config data, type is number",
  "CreatedTime": "the created time of the title config data, type is string, use ISO 8601 date format",
  "UpdatedTime": "the updated time of the title config data, type is string, use ISO 8601 date format"
}

✨️ Request Example

{
  "Key": "xxxx"
}