Permintaan
Informasi dasar
| Bidang | Nilai |
|---|---|
| URL HTTP | https://api.dingtalk.io/v1.0/contact/staffAttributes/visibilitySettings |
| Metode HTTP | POST |
| Tipe aplikasi yang didukung | appType-Aplikasi internal appType-Aplikasi perusahaan pihak ketiga |
| Izin yang diperlukan | permission-Contact.ReachableRule.ReadWrite-Izin pengelolaan visibilitas data Kontak |
Header permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| x-acs-dingtalk-access-token | String | Ya | Kredensial akses yang digunakan untuk memanggil API ini. Dapatkan sebagai berikut: - Untuk aplikasi internal, panggil API Dapatkan access token dari aplikasi internal. - Untuk aplikasi perusahaan pihak ketiga, panggil API Dapatkan access token dari perusahaan yang diotorisasi ke aplikasi pihak ketiga. |
Isi permintaan
| Nama | Tipe | Wajib | Deskripsi |
|---|---|---|---|
| id | Long | Tidak | ID pengaturan. - Kosongkan saat menambahkan pengaturan baru. - Berikan ID pengaturan yang akan diubah saat memperbarui. |
| name | String | Tidak | Nama pengaturan. |
| description | String | Tidak | Deskripsi pengaturan. |
| objectStaffIds | Array of String | Tidak | userId karyawan yang bidangnya disembunyikan. Dapatkan nilai parameter userid dengan memanggil Dapatkan ID pengguna menggunakan kode login senyap. |
| objectDeptIds | Array of Long | Tidak | deptId departemen yang bidangnya disembunyikan. Dapatkan nilai parameter dept_id dengan memanggil Dapatkan daftar departemen. |
| objectTagIds | Array of Long | Tidak | roleId peran yang bidangnya disembunyikan. Dapatkan nilai parameter id dengan memanggil Dapatkan daftar peran organisasi. |
| hideFields | Array of String | Tidak | Daftar ID atribut pengguna yang akan disembunyikan. - Jika atribut pengguna yang akan disembunyikan adalah atribut organisasi kustom, berikan ID atribut. - Jika atribut pengguna yang akan disembunyikan adalah atribut default sistem, berikan daftar atribut default sistem. Daftar atribut default sistem adalah sebagai berikut: - name: Nama - department: Departemen - email: Email - manager: Manajer langsung - title: Jabatan - mobile: Nomor ponsel - ext_number: Nomor ekstensi - work_station: Lokasi Kerja - remark: Alias - hire_date: Tanggal masuk - job_number: ID Karyawan |
| excludeStaffIds | Array of String | Tidak | userId karyawan yang dapat melihat bidang yang disembunyikan. |
| excludeDeptIds | Array of Long | Tidak | deptId departemen yang dapat melihat bidang yang disembunyikan. |
| excludeTagIds | Array of Long | Tidak | roleId peran yang dapat melihat bidang yang disembunyikan. |
| active | Boolean | Tidak | Apakah pengaturan berlaku. - true: Berlaku. - false: Tidak berlaku. |
Contoh permintaan
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" : "Sembunyikan Bidang1",
"description" : "Sembunyikan Bidang1 untuk anggota Departemen A",
"objectStaffIds" : [ "123456" ],
"objectDeptIds" : [ 111 ],
"objectTagIds" : [ 222 ],
"hideFields" : [ "12837","name" ],
"excludeStaffIds" : [ "userId" ],
"excludeDeptIds" : [ 111 ],
"excludeTagIds" : [ 222 ],
"active" : true
}
// File ini dibuat secara otomatis, jangan edit. Terima kasih.
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 {
/**
* Inisialisasi Client akun menggunakan Token
* @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("Sembunyikan Bidang1")
.setDescription("Sembunyikan Bidang1 untuk anggota Departemen A")
.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)) {
// Objek err berisi properti code dan message, yang membantu menemukan masalah
}
} 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)) {
// Objek err berisi properti code dan message, yang membantu menemukan masalah
}
}
}
}
# -*- coding: utf-8 -*-
# File ini dibuat secara otomatis, jangan edit. Terima kasih.
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:
"""
Inisialisasi Client akun menggunakan Token
@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='Sembunyikan Bidang1',
description='Sembunyikan Bidang1 untuk anggota Departemen A',
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):
# Objek err berisi properti code dan message, yang membantu menemukan masalah
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='Sembunyikan Bidang1',
description='Sembunyikan Bidang1 untuk anggota Departemen A',
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):
# Objek err berisi properti code dan message, yang membantu menemukan masalah
pass
if __name__ == '__main__':
Sample.main(sys.argv[1:])
<?php
// File ini dibuat secara otomatis, jangan edit. Terima kasih.
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 {
/**
* Inisialisasi Client akun menggunakan Token
* @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" => "Sembunyikan Bidang1",
"description" => "Sembunyikan Bidang1 untuk anggota Departemen A",
"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)) {
// Objek err berisi properti code dan message, yang membantu menemukan masalah
}
}
}
}
$path = __DIR__ . \DIRECTORY_SEPARATOR . '..' . \DIRECTORY_SEPARATOR . 'vendor' . \DIRECTORY_SEPARATOR . 'autoload.php';
if (file_exists($path)) {
require_once $path;
}
Sample::main(array_slice($argv, 1));
// File ini dibuat secara otomatis, jangan edit. Terima kasih.
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"
)
/**
* Inisialisasi Client akun menggunakan Token
* @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("Sembunyikan Bidang1"),
Description: tea.String("Sembunyikan Bidang1 untuk anggota Departemen A"),
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)) {
// Objek err berisi properti code dan message, yang membantu menemukan masalah
}
}
return _err
}
func main() {
err := _main(tea.StringSlice(os.Args[1:]))
if err != nil {
panic(err)
}
}
// File ini dibuat secara otomatis, jangan edit
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 {
/**
* Inisialisasi Client akun menggunakan Token
* @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: "Sembunyikan Bidang1",
description: "Sembunyikan Bidang1 untuk anggota Departemen A",
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)) {
// Objek err berisi properti code dan message, yang membantu menemukan masalah
}
}
}
}
Client.main(process.argv.slice(2));
// File ini dibuat secara otomatis, jangan edit. Terima kasih.
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
{
/**
* Inisialisasi Client akun menggunakan Token
* @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 = "Sembunyikan Bidang1",
Description = "Sembunyikan Bidang1 untuk anggota Departemen A",
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))
{
// Objek err berisi properti code dan message, yang membantu menemukan masalah
}
}
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))
{
// Objek err berisi properti code dan message, yang membantu menemukan masalah
}
}
}
}
}
// File ini dibuat secara otomatis, jangan edit. Terima kasih.
#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("Sembunyikan Bidang1"))},
{"description", boost::any(string("Sembunyikan Bidang1 untuk anggota Departemen A"))},
{"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)) {
// Objek err berisi properti code dan message, yang membantu menemukan masalah
}
}
}
Respons
Isi respons
| Nama | Tipe | Deskripsi |
|---|---|---|
| result | Long | ID pengaturan. |
Contoh isi respons
HTTP/1.1 200 OK
Content-Type:application/json
{
"result" : 10001
}
Kode error
Jika error dikembalikan saat Anda memanggil API ini, temukan solusinya di dokumen Kode error global berdasarkan pesan error.| HttpCode | Kode error | Pesan error | Deskripsi |
|---|---|---|---|
| 400 | parameter.error | Parameter error | Error parameter |
| 400 | ruleNum.exceed.limit | The number of visibility rules of this type has reached the upper limit | Jumlah aturan telah mencapai batas maksimum |
| 400 | forbid.add.rule | The number of visibility rules for the current organization has exceeded the limit. Adding new rules is not allowed | Penambahan aturan baru tidak diizinkan |
| 400 | directory.invalid | The rule directory is unavailable | Direktori aturan tidak tersedia |
| 500 | system.error | Update error | Error pembaruan |