Get Label Category List

Path

http://{supOS ip:port}/open-api/supos/oodm/v2/model-label-types

Query parameters

Table 2. Query parameter description

Parameter	Type	Description
keyword	string	Fuzzy match the name and alias.
pageIndex	integer	Required. Page number. The default is 1.
pageSize	integer	Required. The number of data on each page. The default is 20 and the maximum is 500.

Response

• 200: Successful.

  {
    "code": 200,
    "data": {
      "data": [
        {
          "appAccessMode": "PUBLIC",
          "appName": "system",
          "comment": "this is a test label",
          "displayName": "category1",
          "enName": "labelCategory1",
          "namespace": "system",
          "id": 17777
        }
      ],
      "pageIndex": 1,
      "pageSize": 20,
      "total": 100
    },
    "detail": "string",
    "message": "ok"
  }
• 500: General internal error of OODM.

  {
    "code": 10001001,
    "data": {},
    "detail": "string",
    "message": "string"
  }

Create Label Category

Path

http://{supOS ip:port}/open-api/supos/oodm/v2/model-label-types

Request Body

{
  "appAccessMode": "PUBLIC", //whether can be seen in other apps (PUBLIC or PRIVATE). Required.
  "appName": "system", //required
  "comment": "this is a test label",
  "displayName": "category1",
  "enName": "labelCategory1", //label alias
  "namespace": "system"
}

Response

• 200: Successful.

  {
    "code": 200,
    "data": 19999,
    "detail": "string",
    "message": "ok"
  }
• 500: General internal error of OODM.

  {
    "code": 10001001,
    "data": {},
    "detail": "string",
    "message": "string"
  }

Get Label/Category

Path

http://{supOS ip:port}/open-api/supos/oodm/v2/model-label-types/{namespace}/{name}

• namespace: Label namespce. Required. String.
• name: Label alias. Required. String.

Response

• 200: Successful.

  {
    "code": 200,
    "data": {
      "appAccessMode": "PUBLIC",
      "appName": "system",
      "comment": "this is a test label",
      "displayName": "category1",
      "enName": "labelCategory1",
      "namespace": "system",
      "id": 17778
    },
    "detail": "string",
    "message": "ok"
  }
• 500: General internal error of OODM.

  {
    "code": 10001001,
    "data": {},
    "detail": "string",
    "message": "string"
  }

Get All Labels

Path

http://{supOS ip:port}/open-api/supos/oodm/v2/model-labels

Query parameters

Table 2. Query parameter description

Parameter	Type	Description
keyword	string	Fuzzy match the name and alias.
pageIndex	integer	Required. Page number. The default is 1.
pageSize	integer	Required. The number of data on each page. The default is 20 and the maximum is 500.
categoryId	integer	Label category ID.
metadataType	string	Metadata type, including ATTRIBUTE, EVENT, SERVICE and SUBSCRIPTION.
excludeMetadata	boolean	Whether to exclude all labels of the metadata. Used together with metadataType.
templateName	string	Template alias. Input with templateNamespace and used together with metadataType.
templateNamespace	string	Template namespace. Input with templateName.
instanceName	string	Instance alias. Used with metadataType.

Response

200: Successful.

{
  "code": 200,
  "data": {
    "data": [
      {
        "appAccessMode": "PUBLIC",
        "appName": "system",
        "comment": "this is a test label",
        "displayName": "category1",
        "enName": "labelCategory1",
        "namespace": "system",
        "id": 17777
      }
    ],
    "pageIndex": 1,
    "pageSize": 20,
    "total": 100
  },
  "detail": "string",
  "message": "ok"
}

Create Label

Path

http://{supOS ip:port}/open-api/supos/oodm/v2/model-labels

Request Body

{
  "appAccessMode": "PUBLIC", //whether can be seen in other apps (PUBLIC or PRIVATE). Required.
  "appName": "system",
  "comment": "this is a test label",
  "displayName": "category1",
  "enName": "labelCategory1",
  "namespace": "system",
  "categoryId": 17777 //interger. Required.
}

Response

• 200: Successful.

  {
    "code": 200,
    "data": 19999,
    "detail": "string",
    "message": "ok"
  }
• 500: General internal error of OODM.

  {
    "code": 10001001,
    "data": {},
    "detail": "string",
    "message": "string"
  }

Cancel Instance Label

Path

http://{supOS ip:port}/open-api/supos/oodm/v2/model-labels/{templateNamespace}/{templateName}/instance-labels

Request Body

{
  "instanceNames": [ //instance name list
    "instance1"
  ],
  "labelIds": [
    14444
  ]
}

Response

• 200: Successful.

  {
    "code": 200,
    "message": "ok",
    "data": null,
    "detail": null
  }
• 500: General internal error of OODM.

  {
    "code": 10001001,
    "data": {},
    "detail": "string",
    "message": "string"
  }

Add Instance Label

Path

http://{supOS ip:port}/open-api/supos/oodm/v2/model-labels/{templateNamespace}/{templateName}/{instanceName}/instance-labels

Request Body

{
  "instanceId": "10001",
  "labelIds": [
    12222
  ],
  "relationId": 12333,
  "templateId": 12332
}

Response

• 200: Successful.

  {
    "code": 200,
    "message": "ok",
    "data": null,
    "detail": null
  }
• 500: General internal error of OODM.

  {
    "code": 10001001,
    "data": {},
    "detail": "string",
    "message": "string"
  }