导航导航条
标志 开发人员回家
例子

介绍

我们的温188bet安卓APP室新员工培训API允许您查询和修改你的员工,和查询公司信息。

如果你不使用我们的新员工培训产品,想知道更多,请访问我们的网站。

这个文档是开源的!随意离开反馈问题GitHub回购或叉和贡献的变化!

GraphQL

188bet安卓APP温室新员工培训只支持GraphQL;我们没有一个传统的REST API。
我们决定使用GraphQL因为它允许您:

一般概念

术语 意义
查询 类似于GET请求,查询返回数据(括号)的返回类型。他们可以把参数(下表中列出查询名称)。
突变 变异数据(类似于POST、PUT补丁,删除)。他们也返回数据(输入括号)。他们也可以把参数(突变下表中列出的名字)。
类型 每种类型GHO中描述了一个对象(例如员工或部门)。每种类型都有自己的一组字段包含的信息(例如:员工有一个名字,部门包含一个名称)。
输入对象 查询和突变输入对象作为参数。这些参数名称和值。要么是一个标量值或更复杂的结构化输入。
标量 最基本的数据类型。所有类型(例如员工)字段包含标量或其他类型,最终归结为标量。
枚举 枚举是硬编码的值。他们都是字符串,必须是一个特定的值。如签名请求的“地位”只能是一个[BEING_PROCESSED取消完成错误WAITING_FOR_COUNTER_SIGNATURE WAITING_FOR_SIGNATURE]。

身份验证

美元curl https://onboarding-api.188bet安卓APPgreenhouse.io/graphql\- x的帖子\- u your_access_key: your_secret_key\- d{“查询”:“{\ n rateLimit {\ n \ n限制}\ n}“}”\- h“application / json内容类型:…>GET / graphql HTTP / 1.1>主持人:onboarding-api.gr188bet安卓APPeenhouse.io>授权:基本eW91cl9hY2Nlc3Nfa2V5OnlvdXJfdmFsdWU=

温室新员188bet安卓APP工培训与HTTP基本身份验证API是安全的HTTPS。客户需要提供用户名和密码。可以生成凭证在温室内部新员工培训产品188bet安卓APP设置> API管理屏幕。只有超级管理员才能生成或撤销的API密钥。使用访问密钥用户名和领域秘密密钥字段作为密码。

API管理

使用温室新员工培训A188bet安卓APPPI提供了访问权所有你们公司的信息。没有办法限制一个API的范围键。只与你信任的人分享你的API密钥。API密钥可以随时撤销API管理屏幕。

速度限制

#当速度达到极限,随后的请求将在以下响应结果#(直到下一个时间开始):{“错误”:[{“消息”:“速度限制。”“限制”:100年,“剩余”:0,“resetAt”:“2018 - 01 - 01 t01:00:00z”}]}

温室新员188bet安卓APP工培训API强加限制单个客户机可以请求的数据量随着时间的推移,以及单个请求的复杂性。这样做是为了确保我们的服务器可以尽快服务请求。

请求限制

#请求当前速率限制信息:{rateLimit {resetAt限制剩余}}# rateLimit回应:{“数据”:{" rateLimit ": {“resetAt”:“2018 - 09 - 12 t18:00:00z”、“限制”:100年,“剩余”:99}}}

为了确保API稳定,我们限制请求的数量,可以在给定的时间窗口。消费者可以通过查询访问这个速率限制信息rateLimit类型(见例子向右)。剩余请求的数量表示的值剩下的字段。当这个请求限制已经达到,每个随后的请求将失败,直到下一个时间窗口(开始resetAt字段)。然后,一旦下次窗口开始,将补充的请求数量(数量表示的限制属性)。

最大的复杂性

#我们有以下查询说:{员工(id: 25) {email}} #请求这个查询的复杂性的分数,这样简单的# include complexityInfo:员工(id: 25) {email} {complexityInfo{分数最大}}#响应:{“数据”:{"员工":{“电子邮件”:“email_address@example.com”},“complexityInfo”:{“分数”:1、“最大”:2500}}}

除了使用请求的数量限制在一个给定的时间段,我们限制任何给定请求的“复杂性”。如果这个分数超过了最大,请求将被拒绝,将返回一条错误消息。

我们有权调整的复杂性得分在任何时候任何给定的字段。然而,就目前而言,一个查询的复杂性分数可以估计就像这样:

客户也可以通过请求确定查询的复杂性的分数complexityInfo对象(参见示例向右)。

一个基本的要求

#如果我们想获取员工的电子邮件地址和ID 25 #, GraphQL查询是这样的:{员工(ID: 25) {email}}
#然后包这个查询到一个JSON对象作为字符串{“查询”:“{\ n员工(id: 25){邮件\ n \ n} \ n} "}
#这是最后的cURL请求将是什么样子的旋度“https://onboarding-api.188bet安卓APPgreenhouse.io/graphql”\- x的帖子\- u your_access_key: your_secret_key\- d{“查询”:“{\ n员工(id: 25){邮件\ n \ n} \ n}“}”\- h“application / json内容类型:#这是响应会是什么样子{“数据”:{“员工”:{“电子邮件”:“employee_25_email@example.com”}}}

GraphQL请求只是文章让我们的API端点。在其最简单的形式,请求负载由一个JSON对象与一个关键:“查询”。“查询”键对应的值是GraphQL查询本身,并表示为一个字符串。

分页

{员工(后,第一:2:“NQ = =”){#请取下一个2记录,开始“NQ = =”后光标pageInfo {endCursor hasNextPage}边缘{节点{email}}}} #返回:{“数据”:{"员工":{" pageInfo ": {“endCursor”:“MTA =”,“hasNextPage”:真正的},“边缘”:[{“节点”:{“电子邮件”:“kima@example.com”}},{“节点”:{“电子邮件”:“omar@example.com”}}]}}}

出于性能方面的原因,一些结果集将是有限的。例如,当要求员工个人信息我们限制员工的数量在一个查询中返回。API将返回一个“页面”的记录以及一个对象,描述了如何得到下一个页面。

我们使用分页系统推荐的GraphQL文档。分页的连接返回以下信息:

获取下一个页面的信息,通过endCursor值到后过滤器连接。你可以看到右边如何获取员工通过一个例子员工连接。

请求分页的资源时,你总是会需要提供一个值第一个或去年参数。您将使用这些参数指定数量的记录应该包含在一个页面上。如果你提供一个值大于最大,你将收到的最大数量的记录。

作为一般规则,我们试图避免嵌套集分页。例如,CustomFieldValue列表记录每个员工将一个简单的数组,而不是另一个分页的连接。

错误和验证

{员工(身份证:100000000){email}}
{“数据”:{“员工”:零},“错误”:({“消息”:“无法找到id为100000000的员工”,“位置”:({“行”:2,“列”:3}),“路径”:(“员工”),“错误代码”:“NotFound”}]}

与REST api, GraphQL将返回的HTTP状态200年,甚至在有错误的情况下。你可以看到一条错误消息的一个示例。的数据和错误属性是兄弟姐妹。有可能一个请求生成一个响应这两个数据和错误。然而,如果曾经有一个错误关键在响应,请求失败(尽管返回代码200)。

的消息会让你知道什么是错的。的位置属性错误的行号和列开始。在本例中,它是第二行,第三列,这是这个词的开始员工。的字段房地产是怎么去的breadcrumb跟踪这个问题。在这里,可以发现在最顶层的问题员工选择。

当我们可以,我们也会提供一个错误代码中的每一个条目的关键错误列表。这是一个表当前错误代码:

错误的情况 错误代码
身份验证失败 身份验证
验证失败 验证
未找到资源 NotFound
服务器错误 服务器
速率限制超过 RateLimit

有未定义错误场景中我们无法提供一个代码。在这些情况下,引用错误列表的内容。

查询

complexityInfo (ComplexityInfo)

# complexityInfo查询的基本结构{complexityInfo{分数最大}}
#的例子,利用复杂性来自员工的信息查询{员工(id: 20){邮件lastName} complexityInfo{分数最大}}

当前的复杂信息查询。本身它并没有告诉我们任何东西。这真是方便,搭配查询。

contactRelationships ((字符串))

{contactRelationships}

有效的选项的列表的“接触”自定义字段类型

国家((国家))

{#请求所有国家信息北美国家(countryCodes:[“美国”,“可以”,“墨西哥人”)){countryCode名字州{名字stateCode国家{名称}}}}
#请求所有国家的所有国家信息{国家{countryCode名字州{名字stateCode国家{名称}}}}

国家的列表

论点 类型 描述 要求
countryCodes (字符串)

customField (CustomField)

#请求自定义字段信息自定义字段{customField (id:“system.pronouns”) {id名称fieldType multipleChoiceOptions customFieldGroup {id名称}teamCategory {id名称}createdAt updatedAt}}

自定义字段的信息。参数必须是永久的自定义字段的字段id。

论点 类型 描述 要求
id ID

customFields (CustomFieldConnection)

#请求光标后的第一个5定制字段“NQ = = " {customFields(后,第一:5:“NQ = =”){边缘节点{{名字id teamCategory {id名称}fieldType customFieldGroup {id名称}multipleChoiceOptions}}}}
#请求光标前的第一个5定制字段" MTA = " {customFields(第一:5:MTA =){边缘节点{{名字id teamCategory {id名称}fieldType customFieldGroup {id名称}multipleChoiceOptions}光标}}}
#请求前10定制字段与字段类型‘文本’{customFields (fieldTypes:第一:10日[文本]){边缘节点{{名字id teamCategory {id名称}fieldType customFieldGroup {id名称}multipleChoiceOptions}光标}}}
#请求列表中的前10 customFields {customFields(第一:10){边缘节点{{名字id teamCategory {id名称}fieldType customFieldGroup {id名称}multipleChoiceOptions}光标}}}
#请求列表中的最后10 customFields {customFields(去年:10){边缘节点{{名字id teamCategory {id名称}fieldType customFieldGroup {id名称}multipleChoiceOptions}光标}}}
#与永久磁场请求定制字段id“部门”和“位置”{customFields(第一:2,id:[“部门”、“位置”]){边缘{节点名字{id teamCategory {id名称}fieldType customFieldGroup {id名称}multipleChoiceOptions}光标}}}

定制字段的集合

论点 类型 描述 要求
后 字符串 返回列表中的元素来指定游标。
之前 字符串 返回列表中的元素之前指定的光标。
fieldTypes (CustomFieldType)
第一个 Int 返回第一个n从列表中元素。
id (ID)
去年 Int 返回最后一个n从列表中元素。

部门(部门)

{部门(id: 1) {id名称externalId}}

一个单独的部门

论点 类型 描述 要求
id Int

部门(DepartmentConnection)

#光标后的第一个5部门申请“NQ = = "{部门(第一:5,后:“NQ = =”){边缘节点名字externalId {id}{光标}}}
#第一光标前5部门请求“NQ = = "{部门(第一:5:“NQ = =”){边缘{光标节点名字externalId {id}}}}
#前10部门请求列表中的{部门(第一:10){边缘节点名字externalId {id}{光标}}}
#过去10部门请求列表中的{部门(去年:10){边缘节点名字externalId {id}{光标}}}

各部门

论点 类型 描述 要求
后 字符串 返回列表中的元素来指定游标。
之前 字符串 返回列表中的元素之前指定的光标。
第一个 Int 返回第一个n从列表中元素。
去年 Int 返回最后一个n从列表中元素。

员工(员工)

#要求员工{员工(id: 5){关于createdAt dateOfBirth dateOfTermination部门名字externalId {id}文件{fileUrl文件名文件大小}}{id文件邮件employmentStatus firstName greenhouseRecruitingData {applicationId} hrManager {id}邮件id lastName位置{id名称地址exter188bet安卓AP118金博宝PnalId}经理邮件{id} middleName otherCriteria {id名称}personalEmail phoneNumber preferredFirstName preferredLastName profileImage {fileUrl文件名文件大小}requiredFieldsCompletedAt startDate可以后缀标题updatedAt workCountryCode}}
#请求一个员工但是限制他们customFieldValues特定customFields。# customFieldIds参数可以使用当你只得到一个特定# customFieldValues感兴趣的员工。{员工(id: 20) {customFieldValues (customFieldIds: [“emergency_contact”、“favorite_food”]) {customField fieldType {id}值}}}
#请求一个员工和限制他们signatureRequests那些等待签名或正在处理{员工(id: 20) {signatureRequests(状态:[WAITING_FOR_SIGNATURE BEING_PROCESSED]){会签文件邮件{id} {fileUrl}地位signatureRequestTemplate {publicName确认邮件{id}}}}}

一个新员工培训的员工记录

论点 类型 描述 要求
id Int

员工(EmployeeConnection)

#光标后要求员工“NQ = = "{员工(第一:25岁后:“NQ = =”) {pageInfo {hasNextPage endCursor}边缘{节点光标邮件{id}}}}
#光标前要求员工“MTM = "{员工(第一:25岁前:“MTM = ") {pageInfo {hasNextPage endCursor}边缘{节点光标邮件{id}}}}
#请求只有那些员工,后被创建在12-13-2021和10-01-2021。#符合这一标准,为每一位员工返回id和工作邮件{员工(createdAt:第一:25日{后:“2021 - 10 - 01 t00:00:00 + 00:00”,:“2021 - 12 - 31 t00:00:00 + 00:00”}) {pageInfo {hasNextPage endCursor}边缘节点{email} {id}}}
#请求只有那些有价值的员工(任何值)设置“favorite_food”自定义字段。对于这些员工,#所有customFieldValues返回。{员工(customFieldValues:第一:25日[{id:“favorite_food”}]) {pageInfo {hasNextPage endCursor}边缘节点{id} {}}}
#请求只有那些员工“热狗”或“鸡块”设置为“favorite_food”定义字段。#因为“favorite_food”自定义字段的类型是文本,我们提供“textValues”参数(而不是# dateValues或idValues){员工(customFieldValues:第一:25日[{id:“favorite_food textValues:[“热狗”,“鸡块”)})){pageInfo {hasNextPage endCursor}边缘节点{{customFieldValues {customField {id}值}}}}}
#请求只有那些有价值的员工设置为他们的“favorite_food”自定义字段和“蓝色”#“favorite_color”自定义字段。为每一个员工,回报他们的ID和工作电子邮件地址。{员工(customFieldValues:第一:25日[{id:“favorite_food”}, {id:“favorite_color textValues:["蓝色"]})){pageInfo {hasNextPage endCursor}边缘节点{email} {id}}}
#要求员工有“favorite_food”自定义字段的值集。返回每个雇员的ID和# customFieldValues,但是只返回的customFieldValue customField“favorite_food”。{员工(customFieldValues:第一:25日[{id:“favorite_food”}]) {pageInfo {hasNextPage endCursor}边缘{节点{id customFieldValues (customFieldIds: [" favorite_food "]) {customField {id}值}}}}}
#要求员工有一个日期值“2017-04-13”与“2018-04-13”(独家)#“1 _year_anniversary”自定义字段。为每一个员工,回报他们的ID和#“1 _year_anniversary”自定义字段的值(并且只有这个自定义字段的值)。customFieldValues{员工(第一:25日:[{id:“1 _year_anniversary”dateValue:{:之前后:“2017-04-13”,“2018-04-13”}})){pageInfo {hasNextPage endCursor}边缘节点{{id customFieldValues (customFieldIds: [" 1 _year_anniversary "]) {customField {id}值}}}}}
#要求员工有员工35或员工40名设置为“导师”自定义字段的值。为每个#这些员工,回报他们的id,工作邮件地址,“关于我”文本。{员工(customFieldValues:第一:25日[{id:“导师”,idValues: [35 40]})) {pageInfo {hasNextPage endCursor}边缘{节点邮件关于}{id}}}
#请求只有那些员工dateOfBirth在1989-12-31和1989-12-31之间。#这些日期是独家(如出生在1989-12-31或2000-01-01的人不会被包括。{员工(dateOfBirthFilter:第一:25日{dateFilter:{后:“1989-12-31”,:“2000-01-01”}}){pageInfo {hasNextPage endCursor}边缘{节点邮件startDate可以}{id}}}
#请求只有那些有一个部门的员工(部门not null)。对于每一个符合条件的员工,#返回id和工作邮件{员工(departmentFilter:第一:25日{anyValue:真}){pageInfo {hasNextPage endCursor}边缘节点{email} {id}}}
#请求只有那些缺乏一个部门的员工(部门为空)。对于每一个符合条件的员工,#返回id和工作邮件{员工(departmentFilter:第一:25日{noValue:真}){pageInfo {hasNextPage endCursor}边缘节点{email} {id}}}
#请求只在特定部门的员工。对于每一个符合条件的员工,#返回id和工作邮件{员工(departmentFilter:第一:25日{departmentIds: [1,3]}) {pageInfo {hasNextPage endCursor}边缘节点{email} {id}}}
#请求只有那些有特定的电子邮件的员工。对于每一个符合条件的员工,#返回id和工作邮件{员工(emailFilter:第一:25日{邮件:[" john.doe@example.com "]}) {pageInfo {hasNextPage endCursor}边缘节点{email} {id}}}
#请求只有那些有特定的员工就业状态。对于每一个符合条件的员工,#返回id和工作邮件{员工(employmentStatusFilter:第一:25日{employmentStatuses:[“全职”、“兼职”]}){pageInfo {hasNextPage endCursor}边缘节点{email} {id}}}
#请求列表中的前10的员工,每个员工返回id和工作邮件{员工(第一:10){pageInfo {hasNextPage endCursor}边缘节点{email} {id}}}
#请求只有那些员工,有一个特定的人力资源经理或经理。对于每一个符合条件的员工,#返回id和工作邮件{员工(hrManagerFilter:第一:25日{hrManagerIds: [1, 2]}) {pageInfo {hasNextPage endCursor}边缘节点{email} {id}}}
#请求列表中的最后10名员工,为每一个员工返回id和工作邮件{员工(去年:10){pageInfo {hasNextPage endCursor}边缘节点{email} {id}}}
#请求只有那些员工在特定位置或位置。对于每一个符合条件的员工,#返回id和工作邮件{员工(locationFilter:第一:25日{locationIds: [1, 2]}) {pageInfo {hasNextPage endCursor}边缘节点{email} {id}}}
#请求只有那些员工,有一个特定的经理或经理。对于每一个符合条件的员工,#返回id和工作邮件{员工(managerFilter:第一:25日{managerIds: [1, 2]}) {pageInfo {hasNextPage endCursor}边缘节点{email} {id}}}
#请求只有那些有一个特定的员工个人电子邮件或电子邮件。对于每一个符合条件的员工,#返回id和工作邮件{员工(personalEmailFilter:第一:25日{personalEmails: [" john.doe@example.com ", " jon.doe2@example.com ")}) {pageInfo {hasNextPage endCursor}边缘节点{email} {id}}}
#请求只有那些员工startDate可以在2017-03-25和2017-03-25之间。#这些日期是独家(例如开始2017-03-25或2018-03-25的人不会被包括。{员工(startDateFilter:第一:25日{dateFilter:{后:“2017-03-25”,:“2018-03-25”}}){pageInfo {hasNextPage endCursor}边缘{节点邮件startDate可以}{id}}}
#请求只有那些标题“客户经理”的员工。对于每一个符合条件的员工,#返回id和工作邮件{员工(titleFilter:第一:25日{标题:[“客户经理”]}){pageInfo {hasNextPage endCursor}边缘节点{email} {id}}}
#请求只有那些员工在一个特定的国家或国家(使用workCountryCode)。对于每一个符合条件的员工,#返回id和工作邮件{员工(workCountryCodeFilter:第一:25日{workCountryCodes:[“美国”,“可以”]}){pageInfo {hasNextPage endCursor}边缘节点{email} {id}}}
#请求只有那些员工,后被更新在12-13-2021和10-01-2021。#符合这一标准,为每一位员工返回id和工作邮件{员工(updatedAt:第一:25日{后:“2021 - 10 - 01 t00:00:00 + 00:00”,:“2021 - 12 - 31 t00:00:00 + 00:00”}) {pageInfo {hasNextPage endCursor}边缘节点{email} {id}}}

新员工培训员工记录的集合。depreacated和应该避免以下论点支持将下降:dateOfBirth, departmentIds,邮件,employmentStatuses, hrManagerIds, locationIds, managerIds, personalEmails, startDate可以,冠军,workCountryCodes。这些参数有一个更新、更强大的同伴叫*过滤器。例如,departmentIds替代了论点departmentFilter——允许部门id的规范,但也允许更大的灵活性(如过滤缺乏/给定的字段的存在——而不是过滤特定的值)。

论点 类型 描述 要求
后 字符串 返回列表中的元素来指定游标。
之前 字符串 返回列表中的元素之前指定的光标。
createdAt DateTimeFilter 基于创建时滤波器的员工
customFieldValues (CustomFieldValuesInput) 筛选员工的自定义字段值
dateOfBirthFilter DateOfBirthFilter 筛选员工的出生日期
departmentFilter DepartmentFilter 过滤器由其部门员工
emailFilter EmailFilter 通过他们的电子邮件过滤的员工
employmentStatusFilter EmploymentStatusFilter 筛选员工的就业状况
第一个 Int 返回第一个n从列表中元素。
hrManagerFilter HrManagerFilter 筛选员工的人力资源经理
去年 Int 返回最后一个n从列表中元素。
locationFilter LocationFilter 筛选员工的位置
managerFilter ManagerFilter 筛选员工的经理
personalEmailFilter PersonalEmailFilter 员工通过个人电子邮件进行过滤
startDateFilter StartDateFilter 筛选员工的开始日期
titleFilter TitleFilter 筛选员工的称号
updatedAt DateTimeFilter 基于上次更新时滤波器的员工
workCountryCodeFilter WorkCountryCodeFilter 过滤器的员工他们的工作国家代码

employmentStatuses ((字符串))

{employmentStatuses}

就业状况的有效的选项列表

位置(位置)

{位置(id: 1) {id名称地址externalId}}

一个位置

论点 类型 描述 要求
id Int

位置(LocationConnection)

#请求前十位置后光标“NQ = = "{位置(第一:10后:“NQ = =”) {pageInfo {hasNextPage endCursor}边缘节点{id名称地址externalId}{光标}}}
#光标之前请求前十位置“NQ = = "{位置(之前,第一:10:“NQ = =”) {pageInfo {hasNextPage endCursor}边缘{节点光标{id名称地址externalId}}}}
#请求列表中的前十位置{位置(第一:10){pageInfo {hasNextPage endCursor}边缘节点{id名称地址externalId}{光标}}}
# 10位置请求列表中的{位置(去年:10){pageInfo {hasNextPage endCursor}边缘节点{id名称地址externalId}{光标}}}

所有位置

论点 类型 描述 要求
后 字符串 返回列表中的元素来指定游标。
之前 字符串 返回列表中的元素之前指定的光标。
第一个 Int 返回第一个n从列表中元素。
去年 Int 返回最后一个n从列表中元素。

otherCriteria (OtherCriterionConnection)

#光标后的第一个10其他标准要求“NQ = = " {otherCriteria(第一:10后:“NQ = =”) {pageInfo {hasNextPage endCursor}边缘{节点{id名称createdAt updatedAt}光标}}}
#请求前十其他标准游标之前“NQ = = " {otherCriteria(第一:10日之前:“NQ = =”) {pageInfo {hasNextPage endCursor}边缘{节点{id名称createdAt updatedAt}光标}}}
#前10的请求列表中的其他标准{otherCriteria(第一:10){pageInfo {hasNextPage endCursor}边缘{节点{id名称createdAt updatedAt}光标}}}
# 10列表中的其他标准要求{otherCriteria(去年:10){pageInfo {hasNextPage endCursor}边缘{节点{id名称createdAt updatedAt}光标}}}

所有其他标准

论点 类型 描述 要求
后 字符串 返回列表中的元素来指定游标。
之前 字符串 返回列表中的元素之前指定的光标。
第一个 Int 返回第一个n从列表中元素。
去年 Int 返回最后一个n从列表中元素。

otherCriterion (OtherCriterion)

{otherCriterion (id: 1) {id名称createdAt updatedAt}}

一个其他标准

论点 类型 描述 要求
id Int

rateLimit (RateLimit)

{rateLimit{成本限制剩余resetAt}}

你当前的API配额信息

团队(团队)

{团队(id: 1) {id名称描述邮件位置名称teamCategory {id名称}}}

一个团队

论点 类型 描述 要求
id Int

teamCategories (TeamCategoryConnection)

#请求前5团队分类后光标“NQ = = " {teamCategories(后,第一:5:“NQ = =”) {pageInfo {hasNextPage endCursor}边缘{节点{id名称}光标}}}
#请求前5团队类别前光标“NQ = = " {teamCategories(第一:5:“NQ = =”) {pageInfo {hasNextPage endCursor}边缘{节点{id名称}光标}}}
#请求前5团队类别列表中的{teamCategories(第一:5){pageInfo {hasNextPage endCursor}边缘{节点{id名称}光标}}}
#昨天5队请求类别列表中的{teamCategories(去年:10){pageInfo {hasNextPage endCursor}边缘{节点{id名称}光标}}}

所有团队的类别

论点 类型 描述 要求
后 字符串 返回列表中的元素来指定游标。
之前 字符串 返回列表中的元素之前指定的光标。
第一个 Int 返回第一个n从列表中元素。
去年 Int 返回最后一个n从列表中元素。

teamCategory (TeamCategory)

{teamCategory (id: 1) {id名称}}

一个团队的类别

论点 类型 描述 要求
id Int

团队(TeamConnection)

#请求前10团队后光标“NQ = = "{团队(第一:10后:“NQ = =”) {pageInfo {hasNextPage endCursor}边缘{节点{id名称描述邮件位置名称teamCategory {id名称}}光标}}}
#光标之前请求前10队”NQ = = "{团队(之前,第一:10:“NQ = =”) {pageInfo {hasNextPage endCursor}边缘{节点{id名称描述邮件位置名称teamCategory {id名称}}光标}}}
#请求前10团队列表中的{团队(第一:10){pageInfo {hasNextPage endCursor}边缘{节点{id名称描述邮件位置名称teamCategory {id名称}}光标}}}
# 10团队请求列表中的{团队(去年:10){pageInfo {hasNextPage endCursor}边缘{节点{id名称描述邮件位置名称teamCategory {id名称}}光标}}}

所有团队

论点 类型 描述 要求
后 字符串 返回列表中的元素来指定游标。
之前 字符串 返回列表中的元素之前指定的光标。
第一个 Int 返回第一个n从列表中元素。
去年 Int 返回最后一个n从列表中元素。

突变

addDepartment (AddDepartmentPayload)

#创建一个部门突变{addDepartment (addDepartmentInput:{名称:“工程”externalId: " 123 "}){部门名字externalId {id}}}

添加一个新的部门

论点 类型 描述 要求
addDepartmentInput AddDepartmentInput ! 要求

addLocation (AddLocationPayload)

#创建一个位置突变{addLocation (addLocationInput:{名称:" Denver, CO "地址:“百老汇1801号13层,丹佛,公司80202年“externalId: " 123 "}){位置{id名称地址externalId}}}

添加一个新的位置

论点 类型 描述 要求
addLocationInput AddLocationInput ! 要求

addPendingHire (PendingHire)

#创建PendingHire和必需的信息作为一个文本自定义字段的值(长文本,可确定的,#和multiple_choice定制字段也以字符串为“价值”)。突变{addPendingHire (pendingHireInfo: {firstName:“乔”姓:“笨蛋”电子邮件:“joe123@example.com”workCountryCode:“美国”customFieldValues: [{customFieldId:“favorite_food”价值:“鸡蛋松饼”}]}){firstName lastName邮件workCountryCode customFieldValues (customFieldIds: [" favorite_food "]) {customField {id}值}}}
#创建PendingHire和必需的信息以及多个选择自定义字段的值。这些自定义#字段需要一个JSON Array-formatted字符串(包括转义引号)的“价值”。还值得注意的是,每一个#数组中的元素必须是一个有效的选择给定的自定义字段。突变{addPendingHire (pendingHireInfo: {firstName:“乔”姓:“笨蛋”电子邮件:“joe123@example.com”workCountryCode:“美国”customFieldValues: [{customFieldId:“required_equipment”价值:“[\“人体工程学键盘\”,\“立式办公桌\]”}]}){firstName lastName邮件workCountryCode customFieldValues (customFieldIds: [" required_equipment "]) {customField {id}值}}}
#创建PendingHire和必需的信息作为一个团队自定义字段的值。这些定制字段#需要一个ID为“价值”。突变{addPendingHire (pendingHireInfo: {firstName:“乔”姓:“笨蛋”电子邮件:“joe123@example.com”workCountryCode:“美国”customFieldValues: [{customFieldId:“primary_social_club”价值:14}]}){firstName lastName邮件workCountryCode customFieldValues {customField {ID}值}}}
#创建PendingHire和必需的信息以及地址的自定义字段的值。这些自定义#字段需要一个JSON Object-formatted字符串(包括转义引号)的“价值”。突变{addPendingHire (pendingHireInfo: {firstName:“乔”姓:“笨蛋”电子邮件:“joe123@example.com”workCountryCode:“美国”customFieldValues: [{customFieldId:“地址”,价值:“{\“address_line_1 \”, \“测试街123号\”,\“address_line_2 \”, \“公寓1 \”,\“\”,\“波尼\”,\“\”,\“\”,\“zipcode \”, \“12345 \”, \“\”, \“美国\“}”}]}){firstName lastName邮件workCountryCode customFieldValues (customFieldIds:["地址"]){customField {id}值}}}
#创建PendingHire和必需的信息以及联系人的自定义字段的值。这些自定义#字段需要一个JSON Object-formatted字符串(包括转义引号)的“价值”。突变{addPendingHire (pendingHireInfo: {firstName:“乔”姓:“笨蛋”电子邮件:“joe123@example.com”workCountryCode:“美国”customFieldValues: [{customFieldId:“emergency_contact”价值:“{\“first_name \”, \“乔\”,\“last_name \”, \“笨蛋\”,\“邮件\”:\“jschmoe@aol.com \”, \“手机\”:\“123.456.7890 \”,\“关系\”,\“\”}”}]}){firstName lastName邮件workCountryCode customFieldValues (customFieldIds: [" emergency_contact "]) {customField {id}值}}}
#创建PendingHire和必需的信息以及日期自定义字段的值。这些定制字段#需要一个字符串格式是这样的:YYYY-MM-DD。突变{addPendingHire (pendingHireInfo: {firstName:“乔”姓:“笨蛋”电子邮件:“joe123@example.com”workCountryCode:“美国”customFieldValues: [{customFieldId:“fully_vested”价值:“2019-12-12”}]}){firstName lastName邮件workCountryCode customFieldValues (customFieldIds: [" fully_vested "]) {customField {id}值}}}

添加一个等待雇佣温室新员工培训188bet安卓APP

论点 类型 描述 要求
pendingHireInfo AddPendingHireInput ! 要求

deleteDepartment (DeleteDepartmentPayload)

#删除一个部门的部门id突变{deleteDepartment (deleteDepartmentInput: {id: 1}) {deletedDepartmentId}}

删除一个部门

论点 类型 描述 要求
deleteDepartmentInput DeleteDepartmentInput ! 要求

deleteLocation (DeleteLocationPayload)

#删除一个位置的位置id突变{deleteLocation (deleteLocationInput: {id: 1}) {deletedLocationId}}

删除一个位置

论点 类型 描述 要求
deleteLocationInput DeleteLocationInput ! 要求

updateDepartment (UpdateDepartmentPayload)

#更新部门的名字。必须提供的id现有部门突变{updateDepartment (updateDepartmentInput: {id: 1名称:“数据科学”externalId: " 123 "}){部门名字externalId {id}}}

更新一个部门

论点 类型 描述 要求
updateDepartmentInput UpdateDepartmentInput ! 要求

updateEmployeeProfile (员工)

#更新员工的工作电子邮件地址,出生日期和部门。这些字段返回确认变化。突变{updateEmployeeProfile (id: 25, employeeUpdates:{电子邮件:“new_email_address@example.com”dateOfBirth:“1985-04-07”部门:1}){邮件dateOfBirth部门{id}}}
#更新/创建一个文本的值,长文本,可确定的,或multiple_choice自定义字段。#这些类型的定制字段,提供一个字符串值。这里我们更新“favorite_food”自定义字段值(定制#一个文本字段),“鸡蛋松饼”。我们要求员工的customFieldValues,但我们限制他们那些#属于“favorite_food”自定义字段。例如我们过滤掉customFieldValues无关。突变{updateEmployeeProfile (id: 20, employeeUpdates: {customFieldValues: [{customFieldId:“favorite_food”价值:“鸡蛋松饼”}]}){customFieldValues (customFieldIds: [" favorite_food "]) {customField {id}值}}}
#更新/创建多个选择自定义字段的值。对于这些定制字段,“价值”必须是一个字符串#代表一个JSON数组(包括转义引号)。还值得注意的是,每个数组的值#必须的一个预定义的值给自定义字段。在这里,我们设置了“required_equipment”自定义字段值#包含“人体工程学键盘”和“立式办公桌”。然后我们请求更新的员工为这个自定义字段的值#确认更改。突变{updateEmployeeProfile (id: 20, employeeUpdates: {customFieldValues: [{customFieldId:“required_equipment”价值:“[\“人体工程学键盘\”,\“立式办公桌\]”}]}){customFieldValues (customFieldIds: [" required_equipment "]) {customField fieldType {id}值}}}
#更新/创建一组自定义字段的值。自定义字段类型的“团队”,我们提供一个ID作为#的值。这个值代表新团队的ID。我们改变了这个员工“primary_social_club”团队14 #。这些团队IDs可以利用团队查询。突变{updateEmployeeProfile (id: 20, employeeUpdates: {customFieldValues: [{customFieldId:“primary_social_club”价值:14}]}){customFieldValues (customFieldIds: [" primary_social_club "]) {customField fieldType {id}值}}}
#更新/创建一个地址自定义字段的值。这些定制字段需要一个字符串值。这个字符串值#必须一个JSON对象(相应地用转义引号)。突变{updateEmployeeProfile (id: 20, employeeUpdates: {customFieldValues: [{customFieldId:“地址”,价值:“{\“address_line_1 \”, \“测试街123号\”,\“address_line_2 \”: \“公寓1 \”,\“\”,\“波尼\”,\“\”,\“\”,\“zipcode \”, \“12345 \”, \“\”, \“美国\“}”}]}){customFieldValues (customFieldIds:["地址"]){customField {id}值}}}
#更新/创建一个联系人自定义字段的值。这些定制字段需要一个字符串值。这个字符串值#必须一个JSON对象(相应地用转义引号)。突变{updateEmployeeProfile (id: 20, employeeUpdates: {customFieldValues: [{customFieldId:“emergency_contact”价值:“{\“first_name \”, \“乔\”,\“last_name \”: \“笨蛋\”,\“邮件\”:\“jschmoe@aol.com \”, \“手机\”:\“123.456.7890 \”,\“关系\”,\“\”}”}]}){customFieldValues (customFieldIds: [" emergency_contact "]) {customField fieldType {id}值}}}
#更新/创建日期自定义字段的值。这些定制字段需要一个字符串格式是这样的:YYYY-MM-DD突变{updateEmployeeProfile (id: 20, employeeUpdates: {customFieldValues: [{customFieldId:“fully_vested”价值:“2019-12-12”}]}){customFieldValues (customFieldIds: [" fully_vested "]) {customField fieldType {id}值}}}
#终止雇员。就业状况和终止日期都是必需的。#终止日期过去可以立即终止或在未来。突变{updateEmployeeProfile (id: 20, employeeUpdates: {employmentStatus:“终止”customFieldValues: {customFieldId:“系统。date_of_termination "值:" 2020-01-01 "}}){id employmentStatus dateOfTermination}}

更新员工档案

论点 类型 描述 要求
employeeUpdates UpdateEmployee ! 要求
id ID ! 要求

updateLocation (UpdateLocationPayload)

#一个位置更新。必须提供现有位置的id。突变{updateLocation (updateLocationInput: {id: 22名:“旧金山”地址:“市场街575号套房# 1750年,旧金山,CA 94105”externalId: " 123 "}){位置{id名称地址externaId}}}

更新一个位置

论点 类型 描述 要求
updateLocationInput UpdateLocationInput ! 要求

类型

AddDepartmentPayload

运行一个addDepartment突变的结果

场 类型 描述
部门 部门 新部门

AddLocationPayload

运行一个addLocation突变的结果

场 类型 描述
位置 位置 新位置

ComplexityInfo

当前请求的复杂性的信息。如果复杂性超过了马克西姆,请求将失败

场 类型 描述
最大 Int !
分数 Int !

国家

一个国家

场 类型 描述
countryCode 字符串!
的名字 字符串!
州 [!]!

CustomField

为贵公司代表单个CustomField记录。CustomFields可以存储并显示在各种各样的方式。通过描述的类型CustomFieldTypes枚举。

场 类型 描述
createdAt DateTime !
customFieldGroup CustomFieldGroup
fieldType CustomFieldType ! 字段类型决定了用户输入和查看数据。
id 字符串! 这CustomField的惟一标识符。
multipleChoiceOptions (字符串!)
的名字 字符串! 这个自定义字段的名称在用户看来温室内部新员工培训。188bet安卓APP
teamCategory TeamCategory
updatedAt DateTime !

CustomFieldConnection

CustomField的连接类型。

场 类型 描述
边缘 (CustomFieldEdge) 边的列表。
节点 (CustomField) 一个节点列表。
pageInfo PageInfo ! 在分页信息援助。

CustomFieldEdge

在一个连接。

场 类型 描述
光标 字符串! 游标使用分页。
节点 CustomField 项目结束时的优势。

CustomFieldGroup

一组自定义字段

场 类型 描述
id ID !
的名字 字符串!

CustomFieldValue

自定义字段值记录

场 类型 描述
createdAt DateTime !
customField CustomField !
updatedAt DateTime !
价值 价值 不同类型的值将被存储基于字段的类型CustomField。一些类型的数据存储为一个嵌套对象。注意,是一个标量类型命名价值。虽然它似乎是一个对象,您不能使用GraphQL来确定它的形状。
valueUpdatedAt DateTime ! 最近更新的时间。

DeleteDepartmentPayload

运行一个deleteDepartment突变的结果

场 类型 描述
deletedDepartmentId ID 部门的ID是删除

DeleteLocationPayload

运行一个deleteLocation突变的结果

场 类型 描述
deletedLocationId ID 位置的ID,只是删除

部门

代表一个部门在你的公司。员工可能会属于零个或一个部门。部门以各种方式用于温室新员工培训,包括权限和新员工培训计划。188bet安卓APP

场 类型 描述
createdAt DateTime !
externalId 字符串
id ID !
的名字 字符串!
updatedAt DateTime !

DepartmentConnection

部门的连接类型。

场 类型 描述
边缘 (DepartmentEdge) 边的列表。
节点 (部门) 一个节点列表。
pageInfo PageInfo ! 在分页信息援助。

DepartmentEdge

在一个连接。

场 类型 描述
光标 字符串! 游标使用分页。
节点 部门 项目结束时的优势。

文档

代表一个文档附加到一个员工。

场 类型 描述
createdAt DateTime !
文件 文件 包含文件的有效载荷。
id ID !
updatedAt DateTime !

员工

一个员工在你的公司工作。员工一流的字段(如标题、start_date邮件),他们还持有custom_field_values用户定义的定制字段。这些二次值customFieldValues数组内举行。

场 类型 描述
关于 字符串 简要描述的员工。这些信息显示在员工的档案和也在欢迎体验报告给该员工的任何新员工。
createdAt DateTime !
customFieldValues (CustomFieldValue !) 该员工的所有其他配置文件信息的列表。管理员可以配置这些字段设置>自定义字段页面。
dateOfBirth 日期 注意,只有管理员可以看到员工的出生年
dateOfTermination 日期 这些信息只能在终止雇员
部门 部门
文档 (文档!) 这些文档来自于温室招聘或被直接连接到员工档案。188bet安卓APP118金博宝这并不包括电子签名请求。
电子邮件 字符串 员工的工作电子邮件。他们需要这个才能登录。
employmentStatus 字符串 有效的选项
firstName 字符串
188bet安卓AP118金博宝PgreenhouseRecruitingData 188bet安卓AP118金博宝PGreenhouseRecruitingData 温室招募188bet安卓APP118金博宝“雇佣”webhook数据
hrManager 员工 员工的人力资源经理。
id ID !
姓 字符串
位置 位置
经理 员工 该员工的直接经理。
middleName 字符串
otherCriteria (OtherCriterion !)
personalEmail 字符串 员工的个人电子邮件。
phoneNumber 字符串
preferredFirstName 字符串 这是你的员工喜欢的名字。如果设置此值,温室新员工培训将显示这个名字的188bet安卓APP产品,而不是员工的法定名称。
preferredLastName 字符串 这是你的员工喜欢的名字。如果设置此值,温室新员工培训将显示这个名字的188bet安卓APP产品,而不是员工的法定名称。
profileImage 文件 一个文件包含员工的形象。这张图片显示在电子邮件、报告和目录页。
signatureRequests (SignatureRequest !) 这些都是电子签名请求发起通过温室新员工培训。188bet安卓APP记住,这些请求可以在许多不同的国家在其生命周期,可能不总是有签署文档可供下载。
startDate可以 日期
后缀 字符串
标题 字符串 员工的职位。
updatedAt DateTime !
workCountryCode 字符串!

EmployeeConnection

员工的连接类型。

场 类型 描述
边缘 (EmployeeEdge) 边的列表。
节点 (员工) 一个节点列表。
pageInfo PageInfo ! 在分页信息援助。

EmployeeEdge

在一个连接。

场 类型 描述
光标 字符串! 游标使用分页。
节点 员工 项目结束时的优势。

文件

一个文件记录

场 类型 描述
expiresAt DateTime URL将到期的时候。这一次之后,您将需要生成一个新的URL。
文件名 字符串 原始文件的名称。
文件大小 Int 文件的大小,以字节为单位
fileUrl 字符串 一个即将到期的URL可以使用下载文件。

188bet安卓AP118金博宝PGreenhouseRecruitingData

188bet安卓APP118金博宝温室招聘的候选人雇用webhook数据

场 类型 描述
applicationId ID ! 188bet安卓APP温室招聘应用程序ID118金博宝
rawData 字符串! 188bet安卓APP118金博宝温室招聘的候选人雇用webhook负载

位置

代表一个单一的位置在你的公司。员工可能会属于零个或一个位置。位置是用于温室新员工培训的方法多种多样,包括权限和新员工培训计划。188bet安卓APP

场 类型 描述
地址 字符串
createdAt DateTime
externalId 字符串
id ID
的名字 字符串
updatedAt DateTime

LocationConnection

位置的连接类型。

场 类型 描述
边缘 (LocationEdge) 边的列表。
pageInfo PageInfo ! 在分页信息援助。

LocationEdge

在一个连接。

场 类型 描述
光标 字符串! 游标使用分页。
节点 位置 项目结束时的优势。

突变

场 类型 描述
addDepartment AddDepartmentPayload 添加一个新的部门
addLocation AddLocationPayload 添加一个新的位置
addPendingHire PendingHire 添加一个等待雇佣温室新员工培训188bet安卓APP
deleteDepartment DeleteDepartmentPayload 删除一个部门
deleteLocation DeleteLocationPayload 删除一个位置
updateDepartment UpdateDepartmentPayload 更新一个部门
updateEmployeeProfile 员工 更新员工档案
updateLocation UpdateLocationPayload 更新一个位置

OtherCriterion

一个标签可以用来完善新员工培训计划

场 类型 描述
createdAt DateTime
id ID
的名字 字符串
updatedAt DateTime

OtherCriterionConnection

OtherCriterion的连接类型。

场 类型 描述
边缘 (OtherCriterionEdge) 边的列表。
pageInfo PageInfo ! 在分页信息援助。

OtherCriterionEdge

在一个连接。

场 类型 描述
光标 字符串! 游标使用分页。
节点 OtherCriterion 项目结束时的优势。

PageInfo

分页的信息连接。

场 类型 描述
endCursor 字符串 方法向前时,光标继续。
hasNextPage 布尔! 方法向前时,有更多的条目吗?
hasPreviousPage 布尔! 方法向后时,有更多的条目吗?
startCursor 字符串 方法向后时,光标继续。

PendingHire

悬而未决的雇佣记录

场 类型 描述
关于 字符串
createdAt DateTime
customFieldValues (CustomFieldValue)
dateOfBirth 日期
部门 部门
电子邮件 字符串
employmentStatus 字符串 有效的选项
firstName 字符串
hrManager 员工
id ID
姓 字符串
位置 位置
经理 员工
personalEmail 字符串
phoneNumber 字符串
preferredFirstName 字符串
preferredLastName 字符串
startDate可以 日期
标题 字符串
updatedAt DateTime
workCountryCode 字符串

RateLimit

你当前的API配额信息

场 类型 描述
成本 Int 这个查询的成本。这个金额是扣除你以前的配额。
限制 Int 你的配额为给定的时期。
剩下的 Int 结余的配额。任何超过这个值将被压制的电话。
resetAt DateTime 当你的配额是重置为其最大价值。

SignatureRequest

一个电子签名请求分配到一个员工。

场 类型 描述
会签 员工 员工负责会签这个文档,如果适用。
createdAt DateTime
文件 文件 这是完成只有签名。
id ID
signatureRequestTemplate SignatureRequestTemplate !
状态 SignatureRequestStatus
updatedAt DateTime

SignatureRequestTemplate

一个模板分配时使用的签名请求。

场 类型 描述
会签 员工 默认的员工负责会签文件从该模板创建,如果适用的话。个人SignatureRequest对象可以覆盖柜台签名者。
createdAt DateTime
的名字 字符串 模板的名称。这是标签管理员会看到。
publicName 字符串 面向公众的模板的名称。这是新员工将会看到。如果这是null,新员工会看到name字段。
updatedAt DateTime

状态

一个国家

场 类型 描述
国家 国家
的名字 字符串
stateCode 字符串

团队

一组记录

场 类型 描述
描述 字符串
电子邮件 字符串
id ID
位置 字符串
的名字 字符串
teamCategory TeamCategory

TeamCategory

一个团队分类记录

场 类型 描述
id ID
的名字 字符串

TeamCategoryConnection

TeamCategory的连接类型。

场 类型 描述
边缘 (TeamCategoryEdge) 边的列表。
pageInfo PageInfo ! 在分页信息援助。

TeamCategoryEdge

在一个连接。

场 类型 描述
光标 字符串! 游标使用分页。
节点 TeamCategory 项目结束时的优势。

TeamConnection

团队的连接类型。

场 类型 描述
边缘 (TeamEdge) 边的列表。
pageInfo PageInfo ! 在分页信息援助。

TeamEdge

在一个连接。

场 类型 描述
光标 字符串! 游标使用分页。
节点 团队 项目结束时的优势。

UpdateDepartmentPayload

运行一个updateDepartment突变的结果

场 类型 描述
部门 部门 更新的部门

UpdateLocationPayload

运行一个updateLocation突变的结果

场 类型 描述
位置 位置 更新后的位置

输入对象

AddDepartmentInput

用于添加一个输入对象部门。

论点 类型 描述 要求
externalId 字符串
的名字 字符串 要求

AddLocationInput

用于添加一个输入对象位置。

论点 类型 描述 要求
地址 字符串
externalId 字符串
的名字 字符串 要求

AddPendingHireInput

新PendingHire指定的属性

论点 类型 描述 要求
关于 字符串
customFieldValues (UpdateCustomFieldValue)
dateOfBirth 日期
部门 ID
电子邮件 字符串 要求
employmentStatus 字符串 有效的选项
firstName 字符串! 要求
hrManager ID
姓 字符串! 要求
位置 ID
经理 ID
middleName 字符串
personalEmail 字符串
phoneNumber 字符串
preferredFirstName 字符串
preferredLastName 字符串
startDate可以 日期
后缀 字符串
标题 字符串
workCountryCode 字符串! 要求

CustomFieldValuesInput

限制员工那些满足指定CustomFieldValue标准。注意:CustomFieldValues属于CustomField CustomFieldType的“蒙面”,不是由textValues滤过性的

论点 类型 描述 要求
dateValue DateFilter
id 字符串! 要求
idValues (Int)
textValues (字符串)

DateFilter

使用在指定的日期(独家>),之前(独家<),或(精确匹配)

论点 类型 描述 要求
后 日期
之前 日期
在 日期

DateOfBirthFilter

筛选员工根据他们的出生日期

论点 类型 描述 要求
anyValue 布尔
dateFilter DateFilter
noValue 布尔

DateTimeFilter

指定一个日期时间范围(独家>)后使用,(独家<之前)

论点 类型 描述 要求
后 DateTime
之前 DateTime

DeleteDepartmentInput

输入用于删除一个对象部门。

论点 类型 描述 要求
id ID ! 要求

DeleteLocationInput

输入用于删除一个对象位置。

论点 类型 描述 要求
id ID ! 要求

DepartmentFilter

过滤器的员工根据他们的部门

论点 类型 描述 要求
anyValue 布尔
departmentIds (Int)
noValue 布尔

EmailFilter

过滤器的员工根据他们的电子邮件地址

论点 类型 描述 要求
anyValue 布尔
电子邮件 (字符串)
noValue 布尔

EmploymentStatusFilter

筛选员工根据他们的就业状况

论点 类型 描述 要求
anyValue 布尔
employmentStatuses (字符串) 有效的选项
noValue 布尔

HrManagerFilter

筛选员工根据他们的人力资源经理

论点 类型 描述 要求
anyValue 布尔
hrManagerIds (Int)
noValue 布尔

LocationFilter

过滤器的员工根据他们的位置

论点 类型 描述 要求
anyValue 布尔
locationIds (Int)
noValue 布尔

ManagerFilter

过滤器的员工根据他们的经理

论点 类型 描述 要求
anyValue 布尔
managerIds (Int)
noValue 布尔

PersonalEmailFilter

筛选员工根据他们的个人电子邮件地址

论点 类型 描述 要求
anyValue 布尔
noValue 布尔
personalEmails (字符串)

StartDateFilter

筛选员工根据他们的开始日期

论点 类型 描述 要求
anyValue 布尔
dateFilter DateFilter
noValue 布尔

TitleFilter

过滤器的员工根据他们的标题

论点 类型 描述 要求
anyValue 布尔
noValue 布尔
标题 (字符串)

UpdateCustomFieldValue

用于更新员工的自定义字段值

论点 类型 描述 要求
customFieldId ID ! 要求
价值 价值

UpdateDepartmentInput

输入对象用于更新部门。

论点 类型 描述 要求
externalId 字符串
id ID ! 要求
的名字 字符串

UpdateEmployee

输入对象用于更新一个员工。

论点 类型 描述 要求
关于 字符串
customFieldValues (UpdateCustomFieldValue)
dateOfBirth 日期
部门 ID
电子邮件 字符串 员工的工作电子邮件。他们需要这个才能登录
employmentStatus 字符串 有效的选项
firstName 字符串
hrManager ID
姓 字符串
位置 ID
经理 ID
middleName 字符串
otherCriteria (ID)
personalEmail 字符串
phoneNumber 字符串
preferredFirstName 字符串
preferredLastName 字符串
profileImage URL
startDate可以 日期
后缀 字符串
标题 字符串
workCountryCode 字符串

UpdateLocationInput

输入对象用于更新位置。

论点 类型 描述 要求
地址 字符串
externalId 字符串
id ID ! 要求
的名字 字符串

WorkCountryCodeFilter

国家代码过滤员工根据他们的工作

论点 类型 描述 要求
anyValue 布尔
noValue 布尔
workCountryCodes (字符串)

标量

布尔

代表真正的或假值。

日期

表示YYYY-MM-DD日期的格式。

DateTime

datetime以ISO8601的代表。

浮动

代表签署双精度小数所指定的值IEEE 754。

ID

代表一个惟一的标识符是Base64混淆视听。它常被用来重新获取一个对象或作为缓存的关键。ID类型出现在一个JSON响应作为字符串;但是,它并不是人类可读的。当预期作为输入类型,任何字符串(如“VXNlci0xMA = = "(比如)或整数4)输入值将被接受为一个ID。

Int

代表non-fractional签署的整数值。Int -(2 ^ 31)之间可以代表值和2 ^ 31 - 1。

字符串

将文本数据表示为utf - 8字符序列。这种类型最常使用GraphQL代表自由的人类可读的文本。

URL

一个url格式的字符串

价值

自定义字段值的实际价值。这种类型的字符串和整数。它的内容取决于相应的fieldType customField。

文本,long_text

multiple_choice

multiple_select

团队

员工

地址

联系

日期

preferred_name

枚举

注:枚举非上市在API输出用户输入,但报价。

CustomFieldType

可能为CustomFieldValues类型值

价值 描述
地址 显示为一组输入。存储为JSON。
联系 显示为一组输入。存储为JSON。
国家 显示下拉。存储为一个字符串。
日期 作为datepicker显示。存储为一个DateTime
员工 显示下拉的员工。存储为一个员工ID。
图像 显示为一个图像。存储为一个文件。
LEGAL_NAME 显示为一组输入。存储为JSON。
LONG_TEXT 显示为一个多行文本框。存储为一个字符串。
戴面具的 显示为一行文本字段(隐藏在应用程序)。存储为一个字符串。
MULTIPLE_CHOICE 显示下拉。存储为一个字符串。
MULTIPLE_SELECT 作为一个标签显示字段。存储为字符串数组。
PREFERRED_NAME 显示为一组输入。存储为JSON。
团队 显示下拉的团队。存储为一组ID。
文本 显示为一行文本字段。存储为一个字符串。

SignatureRequestStatus

可能的签名请求的状态值

价值 描述
BEING_PROCESSED 文档是由我们加工电子签名供应商。
取消了 签名的请求被终止。
完成 文件已成功签署和验证。
错误 不能由于一个错误处理完成电子签名。
WAITING_FOR_COUNTER_SIGNATURE 文档等待会签签名。
WAITING_FOR_SIGNATURE 等待员工签署文档。
例子