跳转到内容

关闭代码

关闭代码是表示关闭请求（工单）/变更请求原因的代码，无论请求/变更是因为完成、拒绝等原因关闭。支持的模块是请求、变更、发布。

属性

id （长整型）
关闭代码的唯一标识符

id （长整型）
被认为具有较大数值的数字位。

示例 

234759602834500

名称 （字符串）
关闭代码的名称

名称 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

Sample Content

描述 （字符串）
关于关闭代码的简短描述

描述 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

Sample Content

模块 （模块）
关闭代码所属的模块。允许的模块有请求、变更。

模块 （模块）
关闭代码所属的模块。允许的模块有请求、变更

示例 

{
  "module": {
    "name": "request",
    "id": "3237392019237402"
  }
}

非激活 （布尔值）
表示关闭代码是否激活

非激活 （布尔值）
布尔值，可能的值为 true 或 false。

添加关闭代码

此操作帮助您添加关闭代码。必填字段为名称和模块。

必填字段：名称，模块

URL

<service domain|custom domain>/app/<portal>/api/v3/closure_codes

属性

id （长整型）
关闭代码的唯一标识符

id （长整型）
被认为具有较大数值的数字位。

示例 

234759602834500

名称 （字符串）
关闭代码的名称

名称 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

Sample Content

描述 （字符串）
关于关闭代码的简短描述

描述 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

Sample Content

模块 （模块）
关闭代码所属的模块。允许的模块有请求、变更。

模块 （模块）
关闭代码所属的模块。允许的模块有请求、变更

示例 

{
  "module": {
    "name": "request",
    "id": "3237392019237402"
  }
}

非激活 （布尔值）
表示关闭代码是否激活

非激活 （布尔值）
布尔值，可能的值为 true 或 false。

$ curl <service domain|custom domain>/app/<portal>/api/v3/closure_codes\
      -X POST\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
  "closure_code": {
    "inactive": false,
    "module": {
      "name": "module-name",
      "id": "2069471914569516"
    },
    "name": "test-name",
    "description": "test-description"
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/closure_codes";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "closure_code": {
    "inactive": false,
    "module": {
      "name": "module-name",
      "id": "2069471914569516"
    },
    "name": "test-name",
    "description": "test-description"
  }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: POST
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/closure_codes"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'
{
  "closure_code": {
    "inactive": false,
    "module": {
      "name": "module-name",
      "id": "2069471914569516"
    },
    "name": "test-name",
    "description": "test-description"
  }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method post -Body $data -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/closure_codes"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "closure_code": {
    "inactive": false,
    "module": {
      "name": "module-name",
      "id": "2069471914569516"
    },
    "name": "test-name",
    "description": "test-description"
  }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="POST")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "closure_code": {
    "inactive": false,
    "module": {
      "name": "module-name",
      "id": "2069471914569516"
    },
    "name": "test-name",
    "description": "test-description",
    "id": "1837561552523828"
  }
}

编辑关闭代码

此操作帮助您编辑关闭代码。

URL

<service domain|custom domain>/app/<portal>/api/v3/closure_codes/{closure_code_id}

属性

id （长整型）
关闭代码的唯一标识符

id （长整型）
被认为具有较大数值的数字位。

示例 

234759602834500

名称 （字符串）
关闭代码的名称

名称 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

Sample Content

描述 （字符串）
关于关闭代码的简短描述

描述 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

Sample Content

模块 （模块）
关闭代码所属的模块。允许的模块有请求、变更。

模块 （模块）
关闭代码所属的模块。允许的模块有请求、变更

示例 

{
  "module": {
    "name": "request",
    "id": "3237392019237402"
  }
}

非激活 （布尔值）
表示关闭代码是否激活

非激活 （布尔值）
布尔值，可能的值为 true 或 false。

$ curl <service domain|custom domain>/app/<portal>/api/v3/closure_codes/{closure_code_id}\
      -X PUT\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      -d input_data='{
  "closure_code": {
    "inactive": false,
    "name": "test-name",
    "description": "test-description"
  }
}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/closure_codes/{closure_code_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {
  "closure_code": {
    "inactive": false,
    "name": "test-name",
    "description": "test-description"
  }
};
params = {"input_data": input_data};
response = invokeurl
[
    url: url
    type: PUT
    parameters: params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/closure_codes/{closure_code_id}"
$headers = @{"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
$input_data = @'
{
  "closure_code": {
    "inactive": false,
    "name": "test-name",
    "description": "test-description"
  }
}
'@
$data = @{ 'input_data' = $input_data}
$response = Invoke-RestMethod -Uri $url -Method put -Body $data -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/closure_codes/{closure_code_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{
  "closure_code": {
    "inactive": false,
    "name": "test-name",
    "description": "test-description"
  }
}'''
data = urlencode({"input_data":input_data}).encode()
httprequest = Request(url, headers=headers,data=data, method="PUT")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "closure_code": {
    "inactive": false,
    "name": "test-name",
    "description": "test-description",
    "id": "2286505663849163"
  }
}

获取关闭代码

此操作帮助您获取关闭代码。

URL

<service domain|custom domain>/app/<portal>/api/v3/closure_codes/{closure_code_id}

属性

id （长整型）
关闭代码的唯一标识符

id （长整型）
被认为具有较大数值的数字位。

示例 

234759602834500

名称 （字符串）
关闭代码的名称

名称 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

Sample Content

描述 （字符串）
关于关闭代码的简短描述

描述 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

Sample Content

模块 （模块）
关闭代码所属的模块。允许的模块有请求、变更。

模块 （模块）
关闭代码所属的模块。允许的模块有请求、变更

示例 

{
  "module": {
    "name": "request",
    "id": "3237392019237402"
  }
}

非激活 （布尔值）
表示关闭代码是否激活

非激活 （布尔值）
布尔值，可能的值为 true 或 false。

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/closure_codes/{closure_code_id}\
      -X GET\
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/closure_codes/{closure_code_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};          
response = invokeurl
[
    url: url
    type: GET
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/closure_codes/{closure_code_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}  
$response = Invoke-RestMethod -Uri $url -Method get -Headers $headers 
$response

#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/closure_codes/{closure_code_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  },
  "closure_code": {
    "inactive": false,
    "module": {
      "name": "module-name",
      "id": "2013381917487827"
    },
    "name": "test-name",
    "description": "test-description",
    "id": "2274307546052747"
  }
}

获取关闭代码列表

此操作帮助您获取关闭代码列表。

URL

<service domain|custom domain>/app/<portal>/api/v3/closure_codes

属性

id （长整型）
关闭代码的唯一标识符

id （长整型）
被认为具有较大数值的数字位。

示例 

234759602834500

名称 （字符串）
关闭代码的名称

名称 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

Sample Content

描述 （字符串）
关于关闭代码的简短描述

描述 （字符串）
纯文本格式。不允许富文本或换行字符。

示例 

Sample Content

模块 （模块）
关闭代码所属的模块。允许的模块有请求、变更。

模块 （模块）
关闭代码所属的模块。允许的模块有请求、变更

示例 

{
  "module": {
    "name": "request",
    "id": "3237392019237402"
  }
}

非激活 （布尔值）
表示关闭代码是否激活

非激活 （布尔值）
布尔值，可能的值为 true 或 false。

$ curl -G <service domain|custom domain>/app/<portal>/api/v3/closure_codes\
      -X GET\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"\
      --data-urlencode input_data='{}'

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/closure_codes";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
input_data = {};
params = {"input_data":input_data};           
response = invokeurl
[
    url: url
    type: GET
    parameters:params
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/closure_codes"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$input_data = @'{}'@
$data = @{ 'input_data' = $input_data}    
$response = Invoke-RestMethod -Uri $url -Method get -Body $data -Headers $headers 
$response

#Python version - 3.8
#This script requires requests module installed in python.
from urllib.error import HTTPError
from urllib.parse import urlencode
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/closure_codes"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
input_data = '''{}'''       
url += "?" + urlencode({"input_data":input_data})
httprequest = Request(url, headers=headers)
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": [
    {
      "status_code": 2000,
      "status": "success"
    }
  ],
  "closure_codes": [
    {
      "inactive": false,
      "module": {
        "name": "module-name",
        "id": "2362509992809814"
      },
      "name": "test-name",
      "description": "test-description",
      "id": "1857152328911857"
    }
  ],
  "list_info": {
    "has_more_rows": false,
    "row_count": 1
  }
}

删除关闭代码

此操作帮助您删除关闭代码。

URL

<service domain|custom domain>/app/<portal>/api/v3/closure_codes/{closure_code_id}


$ curl <service domain|custom domain>/app/<portal>/api/v3/closure_codes/{closure_code_id}\
      -X DELETE\ 
      -H "Accept: application/vnd.manageengine.sdp.v3+json"\
      -H "Authorization: Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"\
      -H "Content-Type: application/x-www-form-urlencoded"

// Deluge Sample script
url = "<service domain|custom domain>/app/<portal>/api/v3/closure_codes/{closure_code_id}";
headers = {"Accept":"application/vnd.manageengine.sdp.v3+json",
           "Content-Type": "application/x-www-form-urlencoded",
           "Authorization": "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"};
response = invokeurl
[
    url: url
    type: DELETE
    headers: headers
];
info response;

#Powershell version - 5.1
$url = "<service domain|custom domain>/app/<portal>/api/v3/closure_codes/{closure_code_id}"
$headers = @{ "Accept" = "application/vnd.manageengine.sdp.v3+json"
    "Authorization" = "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx"
    "Content-Type" = "application/x-www-form-urlencoded"}
$response = Invoke-RestMethod -Uri $url -Method delete -Headers $headers
$response

#Python version - 3.10
from urllib.error import HTTPError
from urllib.request import urlopen,Request

url = "<service domain|custom domain>/app/<portal>/api/v3/closure_codes/{closure_code_id}"
headers ={"Accept": "application/vnd.manageengine.sdp.v3+json", 
          "Authorization" : "Zoho-oauthtoken 1000.7xxx98976ab0xxxxxx19901e7551be57.bxxxx921ed64c04f79622bebcfxxxxxx", 
          "Content-Type" : "application/x-www-form-urlencoded"}
httprequest = Request(url, headers=headers,method="DELETE")
try:
    with urlopen(httprequest) as response:
        print(response.read().decode())
except HTTPError as e:
    print(e.read().decode())

{
  "response_status": {
    "status_code": 2000,
    "status": "success"
  }
}