リクエスト
基本情報
| フィールド | 値 |
|---|---|
| HTTP URL | https://api.dingtalk.io/v1.0/contact/staffAttributes/visibilitySettings |
| HTTP Method | POST |
| サポートされるアプリタイプ | appType-社内アプリ appType-サードパーティ社内アプリ |
| 必要な権限 | permission-Contact.ReachableRule.ReadWrite-連絡先データ表示権限の管理権限 |
リクエストヘッダー
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | はい | 当該インターフェース呼び出しのアクセス認証情報。以下の方法で取得します: - 社内アプリの場合、社内アプリの accessToken を取得するインターフェースを呼び出して取得します。 - サードパーティ社内アプリの場合、サードパーティアプリの認可企業の accessToken を取得するインターフェースを呼び出して取得します。 |
リクエストボディ
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| id | Long | いいえ | 設定 ID。 - 新規追加時は設定 ID を空にします。 - 変更時は変更対象の ID を指定します。 |
| name | String | いいえ | 設定の名前。 |
| description | String | いいえ | 設定の説明情報。 |
| objectStaffIds | Array of String | いいえ | フィールドを非表示にする対象社員の userId。サイレントログインコードでユーザー情報を取得する により userid パラメータ値を取得できます。 |
| objectDeptIds | Array of Long | いいえ | フィールドを非表示にする対象部門の deptId。部門リストを取得する により dept_id パラメータ値を取得できます。 |
| objectTagIds | Array of Long | いいえ | フィールドを非表示にする対象ロールの roleId。企業ロールリストを取得する により id パラメータ値を取得できます。 |
| hideFields | Array of String | いいえ | 非表示にするユーザー属性 ID のリスト。 - 非表示にするユーザー属性が企業カスタム属性の場合、その属性の属性 ID を渡します。 - 非表示にするユーザー属性がシステムデフォルト属性の場合、システムデフォルト属性リストの値を渡します。 システムデフォルト属性リストは以下のとおりです: - name: 名前 - department: 部門 - email: メール - manager: 直属の上司 - title: 職位 - mobile: 携帯電話番号 - ext_number: 内線番号 - work_station: 勤務地 - remark: 表示名 - hire_date: 入社日 - job_number: 社員番号 |
| excludeStaffIds | Array of String | いいえ | 非表示フィールドを表示可能とする社員の userId。 |
| excludeDeptIds | Array of Long | いいえ | 非表示フィールドを表示可能とする部門の deptId。 |
| excludeTagIds | Array of Long | いいえ | 非表示フィールドを表示可能とするロールの roleId。 |
| active | Boolean | いいえ | 有効にするかどうか。 - true:有効 - false:無効 |
リクエスト例
HTTPPOST /v1.0/contact/staffAttributes/visibilitySettings HTTP/1.1
Host:api.dingtalk.io
x-acs-dingtalk-access-token:aec2bd0xxx
Content-Type:application/json
{
"id" : 12364,
"name" : "非表示Field1",
"description" : "部門Aのメンバーの非表示フィールドField1",
"objectStaffIds" : [ "123456" ],
"objectDeptIds" : [ 111 ],
"objectTagIds" : [ 222 ],
"hideFields" : [ "12837","name" ],
"excludeStaffIds" : [ "userId" ],
"excludeDeptIds" : [ 111 ],
"excludeTagIds" : [ 222 ],
"active" : true
}
// This file is auto-generated, don't edit it. Thanks.
package com.aliyun.sample;
import com.aliyun.tea.*;
import com.aliyun.teautil.*;
import com.aliyun.teautil.models.*;
import com.aliyun.dingtalkcontact_1_0.*;
import com.aliyun.dingtalkcontact_1_0.models.*;
import com.aliyun.teaopenapi.*;
import com.aliyun.teaopenapi.models.*;
public class Sample {
/**
* トークンを使用してアカウント Client を初期化します
* @return Client
* @throws Exception
*/
public static com.aliyun.dingtalkcontact_1_0.Client createClient() throws Exception {
Config config = new Config();
config.protocol = "https";
config.regionId = "central";
return new com.aliyun.dingtalkcontact_1_0.Client(config);
}
public static void main(String[] args_) throws Exception {
java.util.List<String> args = java.util.Arrays.asList(args_);
com.aliyun.dingtalkcontact_1_0.Client client = Sample.createClient();
UpdateEmpAttrbuteVisibilitySettingHeaders updateEmpAttrbuteVisibilitySettingHeaders = new UpdateEmpAttrbuteVisibilitySettingHeaders();
updateEmpAttrbuteVisibilitySettingHeaders.xAcsDingtalkAccessToken = "<your access token>";
UpdateEmpAttrbuteVisibilitySettingRequest updateEmpAttrbuteVisibilitySettingRequest = new UpdateEmpAttrbuteVisibilitySettingRequest()
.setId(12364L)
.setName("非表示Field1")
.setDescription("部門Aのメンバーの非表示フィールドField1")
.setObjectStaffIds(java.util.Arrays.asList(
"123456"
))
.setObjectDeptIds(java.util.Arrays.asList(
111L
))
.setObjectTagIds(java.util.Arrays.asList(
222L
))
.setHideFields(java.util.Arrays.asList(
"12837"
))
.setExcludeStaffIds(java.util.Arrays.asList(
"userId"
))
.setExcludeDeptIds(java.util.Arrays.asList(
111L
))
.setExcludeTagIds(java.util.Arrays.asList(
222L
))
.setActive(true);
try {
client.updateEmpAttrbuteVisibilitySettingWithOptions(updateEmpAttrbuteVisibilitySettingRequest, updateEmpAttrbuteVisibilitySettingHeaders, new RuntimeOptions());
} catch (TeaException err) {
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// err には code と message 属性が含まれており、問題の特定に役立ちます
}
} catch (Exception _err) {
TeaException err = new TeaException(_err.getMessage(), _err);
if (!com.aliyun.teautil.Common.empty(err.code) && !com.aliyun.teautil.Common.empty(err.message)) {
// err には code と message 属性が含まれており、問題の特定に役立ちます
}
}
}
}
# -*- coding: utf-8 -*-
# This file is auto-generated, don't edit it. Thanks.
import sys
from typing import List
from alibabacloud_dingtalk.contact_1_0.client import Client as dingtalkcontact_1_0Client
from alibabacloud_tea_openapi import models as open_api_models
from alibabacloud_dingtalk.contact_1_0 import models as dingtalkcontact__1__0_models
from alibabacloud_tea_util import models as util_models
from alibabacloud_tea_util.client import Client as UtilClient
class Sample:
def __init__(self):
pass
@staticmethod
def create_client() -> dingtalkcontact_1_0Client:
"""
トークンを使用してアカウント Client を初期化します
@return: Client
@throws Exception
"""
config = open_api_models.Config()
config.protocol = 'https'
config.region_id = 'central'
return dingtalkcontact_1_0Client(config)
@staticmethod
def main(
args: List[str],
) -> None:
client = Sample.create_client()
update_emp_attrbute_visibility_setting_headers = dingtalkcontact__1__0_models.UpdateEmpAttrbuteVisibilitySettingHeaders()
update_emp_attrbute_visibility_setting_headers.x_acs_dingtalk_access_token = '<your access token>'
update_emp_attrbute_visibility_setting_request = dingtalkcontact__1__0_models.UpdateEmpAttrbuteVisibilitySettingRequest(
id=12364,
name='非表示Field1',
description='部門Aのメンバーの非表示フィールドField1',
object_staff_ids=[
'123456'
],
object_dept_ids=[
111
],
object_tag_ids=[
222
],
hide_fields=[
'12837'
],
exclude_staff_ids=[
'userId'
],
exclude_dept_ids=[
111
],
exclude_tag_ids=[
222
],
active=True
)
try:
client.update_emp_attrbute_visibility_setting_with_options(update_emp_attrbute_visibility_setting_request, update_emp_attrbute_visibility_setting_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err には code と message 属性が含まれており、問題の特定に役立ちます
pass
@staticmethod
async def main_async(
args: List[str],
) -> None:
client = Sample.create_client()
update_emp_attrbute_visibility_setting_headers = dingtalkcontact__1__0_models.UpdateEmpAttrbuteVisibilitySettingHeaders()
update_emp_attrbute_visibility_setting_headers.x_acs_dingtalk_access_token = '<your access token>'
update_emp_attrbute_visibility_setting_request = dingtalkcontact__1__0_models.UpdateEmpAttrbuteVisibilitySettingRequest(
id=12364,
name='非表示Field1',
description='部門Aのメンバーの非表示フィールドField1',
object_staff_ids=[
'123456'
],
object_dept_ids=[
111
],
object_tag_ids=[
222
],
hide_fields=[
'12837'
],
exclude_staff_ids=[
'userId'
],
exclude_dept_ids=[
111
],
exclude_tag_ids=[
222
],
active=True
)
try:
await client.update_emp_attrbute_visibility_setting_with_options_async(update_emp_attrbute_visibility_setting_request, update_emp_attrbute_visibility_setting_headers, util_models.RuntimeOptions())
except Exception as err:
if not UtilClient.empty(err.code) and not UtilClient.empty(err.message):
# err には code と message 属性が含まれており、問題の特定に役立ちます
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?php
// This file is auto-generated, don't edit it. Thanks.
namespace AlibabaCloud\SDK\Sample;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Dingtalk;
use \Exception;
use AlibabaCloud\Tea\Exception\TeaError;
use AlibabaCloud\Tea\Utils\Utils;
use Darabonba\OpenApi\Models\Config;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\UpdateEmpAttrbuteVisibilitySettingHeaders;
use AlibabaCloud\SDK\Dingtalk\Vcontact_1_0\Models\UpdateEmpAttrbuteVisibilitySettingRequest;
use AlibabaCloud\Tea\Utils\Utils\RuntimeOptions;
class Sample {
/**
* トークンを使用してアカウント Client を初期化します
* @return Dingtalk Client
*/
public static function createClient(){
$config = new Config([]);
$config->protocol = "https";
$config->regionId = "central";
return new Dingtalk($config);
}
/**
* @param string[] $args
* @return void
*/
public static function main($args){
$client = self::createClient();
$updateEmpAttrbuteVisibilitySettingHeaders = new UpdateEmpAttrbuteVisibilitySettingHeaders([]);
$updateEmpAttrbuteVisibilitySettingHeaders->xAcsDingtalkAccessToken = "<your access token>";
$updateEmpAttrbuteVisibilitySettingRequest = new UpdateEmpAttrbuteVisibilitySettingRequest([
"id" => 12364,
"name" => "非表示Field1",
"description" => "部門Aのメンバーの非表示フィールドField1",
"objectStaffIds" => [
"123456"
],
"objectDeptIds" => [
111
],
"objectTagIds" => [
222
],
"hideFields" => [
"12837"
],
"excludeStaffIds" => [
"userId"
],
"excludeDeptIds" => [
111
],
"excludeTagIds" => [
222
],
"active" => true
]);
try {
$client->updateEmpAttrbuteVisibilitySettingWithOptions($updateEmpAttrbuteVisibilitySettingRequest, $updateEmpAttrbuteVisibilitySettingHeaders, new RuntimeOptions([]));
}
catch (Exception $err) {
if (!($err instanceof TeaError)) {
$err = new TeaError([], $err->getMessage(), $err->getCode(), $err);
}
if (!Utils::empty_($err->code) && !Utils::empty_($err->message)) {
// err には code と message 属性が含まれており、問題の特定に役立ちます
}
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
Sample::main(array_slice($argv, 1));
// This file is auto-generated, don't edit it. Thanks.
package main
import (
"os"
util "github.com/alibabacloud-go/tea-utils/service"
dingtalkcontact_1_0 "github.com/alibabacloud-go/dingtalk/contact_1_0"
openapi "github.com/alibabacloud-go/darabonba-openapi/client"
"github.com/alibabacloud-go/tea/tea"
)
/**
* トークンを使用してアカウント Client を初期化します
* @return Client
* @throws Exception
*/
func CreateClient () (_result *dingtalkcontact_1_0.Client, _err error) {
config := &openapi.Config{}
config.Protocol = tea.String("https")
config.RegionId = tea.String("central")
_result = &dingtalkcontact_1_0.Client{}
_result, _err = dingtalkcontact_1_0.NewClient(config)
return _result, _err
}
func _main (args []*string) (_err error) {
client, _err := CreateClient()
if _err != nil {
return _err
}
updateEmpAttrbuteVisibilitySettingHeaders := &dingtalkcontact_1_0.UpdateEmpAttrbuteVisibilitySettingHeaders{}
updateEmpAttrbuteVisibilitySettingHeaders.XAcsDingtalkAccessToken = tea.String("<your access token>")
updateEmpAttrbuteVisibilitySettingRequest := &dingtalkcontact_1_0.UpdateEmpAttrbuteVisibilitySettingRequest{
Id: tea.Int64(12364),
Name: tea.String("非表示Field1"),
Description: tea.String("部門Aのメンバーの非表示フィールドField1"),
ObjectStaffIds: []*string{tea.String("123456")},
ObjectDeptIds: []*int64{tea.Int(111)},
ObjectTagIds: []*int64{tea.Int(222)},
HideFields: []*string{tea.String("12837")},
ExcludeStaffIds: []*string{tea.String("userId")},
ExcludeDeptIds: []*int64{tea.Int(111)},
ExcludeTagIds: []*int64{tea.Int(222)},
Active: tea.Bool(true),
}
tryErr := func()(_e error) {
defer func() {
if r := tea.Recover(recover()); r != nil {
_e = r
}
}()
_, _err = client.UpdateEmpAttrbuteVisibilitySettingWithOptions(updateEmpAttrbuteVisibilitySettingRequest, updateEmpAttrbuteVisibilitySettingHeaders, &util.RuntimeOptions{})
if _err != nil {
return _err
}
return nil
}()
if tryErr != nil {
var err = &tea.SDKError{}
if _t, ok := tryErr.(*tea.SDKError); ok {
err = _t
} else {
err.Message = tea.String(tryErr.Error())
}
if !tea.BoolValue(util.Empty(err.Code)) && !tea.BoolValue(util.Empty(err.Message)) {
// err には code と message 属性が含まれており、問題の特定に役立ちます
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// This file is auto-generated, don't edit it
import Util, * as $Util from '@alicloud/tea-util';
import dingtalkcontact_1_0, * as $dingtalkcontact_1_0 from '@alicloud/dingtalk/contact_1_0';
import OpenApi, * as $OpenApi from '@alicloud/openapi-client';
import * as $tea from '@alicloud/tea-typescript';
export default class Client {
/**
* トークンを使用してアカウント Client を初期化します
* @return Client
* @throws Exception
*/
static createClient(): dingtalkcontact_1_0 {
let config = new $OpenApi.Config({ });
config.protocol = "https";
config.regionId = "central";
return new dingtalkcontact_1_0(config);
}
static async main(args: string[]): Promise<void> {
let client = Client.createClient();
let updateEmpAttrbuteVisibilitySettingHeaders = new $dingtalkcontact_1_0.UpdateEmpAttrbuteVisibilitySettingHeaders({ });
updateEmpAttrbuteVisibilitySettingHeaders.xAcsDingtalkAccessToken = "<your access token>";
let updateEmpAttrbuteVisibilitySettingRequest = new $dingtalkcontact_1_0.UpdateEmpAttrbuteVisibilitySettingRequest({
id: 12364,
name: "非表示Field1",
description: "部門Aのメンバーの非表示フィールドField1",
objectStaffIds: [
"123456"
],
objectDeptIds: [
111
],
objectTagIds: [
222
],
hideFields: [
"12837"
],
excludeStaffIds: [
"userId"
],
excludeDeptIds: [
111
],
excludeTagIds: [
222
],
active: true,
});
try {
await client.updateEmpAttrbuteVisibilitySettingWithOptions(updateEmpAttrbuteVisibilitySettingRequest, updateEmpAttrbuteVisibilitySettingHeaders, new $Util.RuntimeOptions({ }));
} catch (err) {
if (!Util.empty(err.code) && !Util.empty(err.message)) {
// err には code と message 属性が含まれており、問題の特定に役立ちます
}
}
}
}
Client.main(process.argv.slice(2));
// This file is auto-generated, don't edit it. Thanks.
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Threading.Tasks;
using Tea;
using Tea.Utils;
namespace AlibabaCloud.SDK.Sample
{
public class Sample
{
/**
* トークンを使用してアカウント Client を初期化します
* @return Client
* @throws Exception
*/
public static AlibabaCloud.SDK.Dingtalkcontact_1_0.Client CreateClient()
{
AlibabaCloud.OpenApiClient.Models.Config config = new AlibabaCloud.OpenApiClient.Models.Config();
config.Protocol = "https";
config.RegionId = "central";
return new AlibabaCloud.SDK.Dingtalkcontact_1_0.Client(config);
}
public static void Main(string[] args)
{
AlibabaCloud.SDK.Dingtalkcontact_1_0.Client client = CreateClient();
AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.UpdateEmpAttrbuteVisibilitySettingHeaders updateEmpAttrbuteVisibilitySettingHeaders = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.UpdateEmpAttrbuteVisibilitySettingHeaders();
updateEmpAttrbuteVisibilitySettingHeaders.XAcsDingtalkAccessToken = "<your access token>";
AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.UpdateEmpAttrbuteVisibilitySettingRequest updateEmpAttrbuteVisibilitySettingRequest = new AlibabaCloud.SDK.Dingtalkcontact_1_0.Models.UpdateEmpAttrbuteVisibilitySettingRequest
{
Id = 12364,
Name = "非表示Field1",
Description = "部門Aのメンバーの非表示フィールドField1",
ObjectStaffIds = new List<string>
{
"123456"
},
ObjectDeptIds = new List<long?>
{
111
},
ObjectTagIds = new List<long?>
{
222
},
HideFields = new List<string>
{
"12837"
},
ExcludeStaffIds = new List<string>
{
"userId"
},
ExcludeDeptIds = new List<long?>
{
111
},
ExcludeTagIds = new List<long?>
{
222
},
Active = true,
};
try
{
client.UpdateEmpAttrbuteVisibilitySettingWithOptions(updateEmpAttrbuteVisibilitySettingRequest, updateEmpAttrbuteVisibilitySettingHeaders, new AlibabaCloud.TeaUtil.Models.RuntimeOptions());
}
catch (TeaException err)
{
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err には code と message 属性が含まれており、問題の特定に役立ちます
}
}
catch (Exception _err)
{
TeaException err = new TeaException(new Dictionary<string, object>
{
{ "message", _err.Message }
});
if (!AlibabaCloud.TeaUtil.Common.Empty(err.Code) && !AlibabaCloud.TeaUtil.Common.Empty(err.Message))
{
// err には code と message 属性が含まれており、問題の特定に役立ちます
}
}
}
}
}
// This file is auto-generated, don't edit it. Thanks.
#include <alibabacloud/dingtalkcontact__1__0.hpp>
#include <alibabacloud/open_api.hpp>
#include <boost/any.hpp>
#include <darabonba/core.hpp>
#include <darabonba/util.hpp>
#include <iostream>
#include <map>
using namespace std;
Alibabacloud_Dingtalkcontact_1_0::Client createClient() {
shared_ptr<Alibabacloud_OpenApi::Config> config = make_shared<Alibabacloud_OpenApi::Config>();
config->protocol = make_shared<string>("https");
config->regionId = make_shared<string>("central");
return Alibabacloud_Dingtalkcontact_1_0::Client(config);
}
int main(int argc, char *args[]) {
args;
shared_ptr<Alibabacloud_Dingtalkcontact_1_0::Client> client = make_shared<Alibabacloud_Dingtalkcontact_1_0::Client>(createClient());
shared_ptr<Alibabacloud_Dingtalkcontact_1_0::UpdateEmpAttrbuteVisibilitySettingHeaders> updateEmpAttrbuteVisibilitySettingHeaders = make_shared<Alibabacloud_Dingtalkcontact_1_0::UpdateEmpAttrbuteVisibilitySettingHeaders>();
updateEmpAttrbuteVisibilitySettingHeaders->xAcsDingtalkAccessToken = make_shared<string>("<your access token>");
shared_ptr<Alibabacloud_Dingtalkcontact_1_0::UpdateEmpAttrbuteVisibilitySettingRequest> updateEmpAttrbuteVisibilitySettingRequest = make_shared<Alibabacloud_Dingtalkcontact_1_0::UpdateEmpAttrbuteVisibilitySettingRequest>(map<string, boost::any>({
{"id", boost::any(12364)},
{"name", boost::any(string("非表示Field1"))},
{"description", boost::any(string("部門Aのメンバーの非表示フィールドField1"))},
{"objectStaffIds", boost::any(vector<string>({
"123456"
}))},
{"objectDeptIds", boost::any(vector<long>({
111
}))},
{"objectTagIds", boost::any(vector<long>({
222
}))},
{"hideFields", boost::any(vector<string>({
"12837"
}))},
{"excludeStaffIds", boost::any(vector<string>({
"userId"
}))},
{"excludeDeptIds", boost::any(vector<long>({
111
}))},
{"excludeTagIds", boost::any(vector<long>({
222
}))},
{"active", boost::any(true)}
}));
try {
client->updateEmpAttrbuteVisibilitySettingWithOptions(updateEmpAttrbuteVisibilitySettingRequest, updateEmpAttrbuteVisibilitySettingHeaders, make_shared<Darabonba_Util::RuntimeOptions>(Darabonba_Util::RuntimeOptions()));
}
catch (std::exception &err) {
if (!Darabonba_Util::Client::empty(err.code) && !Darabonba_Util::Client::empty(err.message)) {
// err には code と message 属性が含まれており、問題の特定に役立ちます
}
}
}
レスポンス
レスポンスボディ
| 名前 | タイプ | 説明 |
|---|---|---|
| result | Long | 設定 ID。 |
レスポンスボディの例
HTTP/1.1 200 OK
Content-Type:application/json
{
"result" : 10001
}
エラーコード
当該インターフェースの呼び出しでエラーが発生した場合、エラーメッセージをもとにグローバルエラーコードドキュメントから解決方法を検索できます。| HttpCode | エラーコード | エラーメッセージ | 説明 |
|---|---|---|---|
| 400 | parameter.error | パラメータエラー | パラメータエラー |
| 400 | ruleNum.exceed.limit | 当該タイプの表示権限ルール数が上限に達しています | ルール数が上限に達しています |
| 400 | forbid.add.rule | 現在の企業の表示権限ルール数が上限を超えており、新規追加は禁止されています | 新規追加が禁止されています |
| 400 | directory.invalid | ルールの directory が使用できません | ルールの directory が使用できません |
| 500 | system.error | 更新エラー | 更新エラー |