根据主键ID集合获取指定的通用对象信息

POST

/TenantBaseExternal/api/v5/CommonMetaObject/GetByIds

接口限制：100次/秒/企业 3000次/分钟/企业

适用场景：1.查询已知主键ID集合的指定的通用对象相关信息
2.支持对象列表：法人公司(Corporation),组织类型(OrganizationType),组织层级(OrganizationLevel),任职类型(ServiceType),异动类型(EmpTransitionType),变动原因(EmpChangeReason),人员来源(EmploymentSource),人员类别(EmploymentType),用工形式(EmploymentForm),离职去向(DimissionWhereabouts)

警告信息：1.ID列表元素个数需小于等于300，且为主键GUID
2.由于是通用对象，每个对象字段不同，故使用动态参数作为响应结果

tips：1.该处为通用对象主键ID集合，示例：["7816d0fc-d684-4ada-99fa-e778eb7c096e","12a1517b-fc48-4032-9a49-0e08fc1e23e7"]
2.支持查询已删除的数据
3.默认排序条件：无

错误码示例

{
"data": null,
"code": "417",
"message": "MetaObjectName不能为空"
}

请求示例

Shell

JavaScript

Java

Swift

curl --location --request POST 'https://openapi.italent.cn/TenantBaseExternal/api/v5/CommonMetaObject/GetByIds' \
--header 'Content-Type: application/json' \
--data-raw '{
  "metaObjectName": "DimissionWhereabouts",//对象名称
  "ids": [//主键ID列表
    "00a56b67-5c84-4863-964c-9b1e630cb423",
    "33db54c9-a830-47f8-926d-62cc2a26bdb5"
  ],
  "columns": null, //查询列  
  "enableTranslate": true //开启数据源自动翻译功    
}'

响应示例

{
  "data": [
    {
      "fields": {
        "property1": {},
        "property2": {}
      }
    }
  ],
  "code": "string",
  "message": "string"
}

请求参数

Body 参数application/json

metaObjectName

string

必需

通用对象实体对象名称，示例：Corporation。
支持子集列表：
1.法人公司(Corporation)
2.组织类型(OrganizationType)
3.组织层级(OrganizationLevel)
4.任职类型(ServiceType)
5.异动类型(EmpTransitionType)
6.变动原因(EmpChangeReason)
7.人员来源(EmploymentSource)
8.人员类别(EmploymentType)
9.用工形式(EmploymentForm)
10.离职去向(DimissionWhereabouts)

ids

array[string]

必需

业务主键GUID集合，示例：["20ed93de-ea5c-467c-a8af-0c8306ea412a","0cdbf604-b445-4174-ae65-eef4ec508500"]

isWithDeleted

boolean

可选

是否包括已删除数据，默认否，示例：true/false

columns

array[string]

可选

查询字段列表，默认为null(获取全部信息)，非必填。注意：该参数仅表示是否查询该列的值，不控制响应模型的字段。例：["Name","OId","Code","Status"]

enableTranslate

boolean

可选

是否开启动态翻译，默认否，示例：true/false。开启后，自动翻译数据源等字典类型字段，结果在响应参数的TranslateProperties中，key为对应字段加Text后缀，值为翻译后文本

示例

返回响应

🟢200响应结果

application/json

Body

data

array [object {1}]

可选

fields

object

可选

业务相关动态字段数据字典表（字段名称-值），注意：自定义字段在CustomProperties中。示例：{"StartDate": "2021-01-01","StopDate": "2021-01-31"}

code

string

可选

响应码（正常情况必须200）或异常错误编码（异常情况）：200-OK，417-参数异常、业务不合法，500-内部服务器异常。示例："200"

message

string

结果消息

可选

修改于 2021-10-13 10:54:24

根据时间窗滚动查询变动的通用对象信息

部分更新指定子集对象相关信息

根据主键ID集合获取指定的通用对象信息

错误码示例#

请求参数

返回响应

错误码示例