纳税
例子

介绍

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

如果您不使用我们的Onboarding产品,并想了解更多,请访问我们的网站。

本文档是开源的!随意留下反馈作为问题GitHub库或叉子,并有助于改变!

GraphQL.

188bet安卓APP温室onboard只支持GraphQL.;我们没有传统的休息API。
我们决定使用GraphQL,因为它允许您:

一般概念

学期 意义
询问 类似于GET请求,查询返回数据(返回类型为括号)。他们可以采取参数(在查询名称下列出的表中)。
突变 变异数据(类似于Post,Put,Patch,Delete)。它们还返回数据(键入括号)。它们也可以采取参数(在突变名称下列出表中)。
类型 每种类型都描述了Gho(例如员工或部门)的对象。每种类型都有自己的一组包含信息的字段(例如,员工有一个名字,部门包含一个描述)。
输入对象 查询和突变将输入对象作为参数。这些参数有名称和值。该值将是标量或更复杂的结构化输入。
标量 最基本的数据类型。所有类型(例如,员工)都有含有标量或其他类型的字段,最终沸腾到标量。
枚举 枚举是硬编码的值。它们是必须具有一定价值的字符串。例如。签名请求的“状态”只能是[BES_PROCESSED已取消的已完成错误_for_counter_signature severing_for_signature]之一。

验证

$卷曲https://onboarding-api.gre188bet安卓APPenhouse.io/graphql.\-X帖子\-u your_access_key:your_secret_key\-D.'{“查询”:“{\ n Ratelimit {\ n limit \ n} \ n}”}“\-H“内容类型:应用程序/ JSON”......>get / graphql http / 1.1>主机:onboard-api.greenh188bet安卓APPouse.io.>授权:基本ew91cl9hy2nlc3nfa2v5onlvdxjfdmfsdwu.=

温室入职188bet安卓APP培训API固定与HTTP基本身份验证通过HTTPS。客户需要同时提供用户名和密码。凭证可以在生成温室内入职培训产物188bet安卓APP设置> API管理屏幕.只有超级管理员可以生成或撤消API键。使用访问密钥现场作为用户名和密钥字段作为密码。

API管理

使用温室onboar188bet安卓APPding API提供访问全部贵公司的信息。有没有办法限制API密钥的范围。只有人分享您的API密钥,你信任的人。API密钥可以在API管理屏幕上的任何时间予以撤销。

速率限制

{"errors": [{"message": " rate limit reached.", "limit": 100, "remaining": 0, "resetAt": "2018-01-01 t01:00:00 . z "}]}

onbo188bet安卓APParding API的温室对单个客户端可以随时间要求的数据量以及各个请求的复杂性来施加限制。这样做是为了确保我们的服务器始终可以尽快服务请求。

要求限制

#要请求当前速率限制信息:{RATELIMIT {RESETAT限制剩余}}#RATELIMIT响应:{“数据”:{“RATELIMIT”:{“RESETAT”:“2018-09-12T18:00:00:00z”,“限制“:100,”剩余“:99}}}

为了确保API稳定性,我们限制了在给定时间窗口内的请求数。消费者可以通过查询来访问此速率限制信息Ratelimit.类型(右侧看到示例)。剩余请求的数量由该值表示其余的场地。达到此请求限制时,在下次窗口开始之前,每次随后的请求都会失败(由resetat.场地)。然后,下次窗口开始后,将补充请求的数量(到所示的数字限制财产)。

最大的复杂性

#说我们有以下查询:{employee(ID:25){email}}#请求此查询的复杂性分数,只是#包含复杂性,如此:{员工(ID:25){email} complexityInfo {得分最大}}#响应:{“数据”:{“employee”:{“电子邮件”:“email_address@example.com”},“compleasityinfo”:{“得分”: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'内容类型:应用程序/ JSON'#而这是响应的样子{“数据”{“员工”{“电子邮件”“employee_25_email@example.com”}}}

GraphQL请求只是发送到API端点的post。在最简单的形式中,请求有效负载由一个JSON对象和一个键组成:“query”。“query”键对应的值是GraphQL查询本身,它被表示为一个字符串。

分页

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

出于性能原因,某些结果集的大小将受到限制。例如,当请求员工配置文件信息时,我们限制在单个查询中返回的员工数量。API将返回“页面”记录以及描述如何获取下一页的对象。

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

要获取下一页信息,请传递endcursor值到过滤连接。在右边,您可以通过以下方式查看如何获取员工的示例员工联系。

当请求分页资源,你将永远需要为要么提供一个值第一的要么去年论点。您将使用这些参数来指定页面上应包含的记录数。如果您提供比我们最大值大的值,您将收到最大记录数。

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

错误和验证

{employee(id: 100000000) {email}}
{“数据”{“员工”无效的},“错误”[{“消息”“无法找到员工ID 100000000”“地方”[{“线”2“柱子”3.}],“小路”[“员工”],“错误代码”“未找到”}]}

与REST API不同,GraphQL将返回200的HTTP状态,即使在存在错误的情况下也是如此。您可以看到右侧错误消息的示例。这数据错误属性是兄弟姐妹。这是可能的请求生成具有响应两个都数据错误.但是,如果有一个过错误键入响应,请求失败(尽管返回代码为200)。

信息会让你知道什么是错的。这地点属性具有错误开始的行号和列。在这个例子中,它是第二行第三列,也就是单词的开头员工.这字段物业是一种宽面条的迹线如何到达问题。在这里,可以在最顶层找到问题员工选择。

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

错误方案 错误代码
验证失败 验证
验证失败 验证
未找到资源 未找到
服务器错误 服务器
超过限速 Ratelimit.

有未定义的错误方案,其中我们无法提供代码。在这些情况下,请参阅错误列表的内容。

疑问

ComplexityInfo(ComplexityInfo

当前查询的复杂性信息

Contactrelationships([细绳]

“联系人”自定义字段类型的有效选项列表

国家((国家)

国家名单

争论 类型 描述 必需的
国家/地区 [细绳]

customfield(的CustomField

自定义字段

争论 类型 描述 必需的
ID ID

customfields(CustomFieldConnection.

自定义字段的集合

争论 类型 描述 必需的
细绳 返回指定光标后的列表中的元素。
细绳 返回列表中位于指定游标之前的元素。
Fieldtypes. [customfieldtype]
第一的 返回第一个N列表中的元素。
id [ID]
去年 返回最后一个N列表中的元素。

部门(

单个部门

争论 类型 描述 必需的
ID

部门(DepartmentConnection

所有部门

争论 类型 描述 必需的
细绳 返回指定光标后的列表中的元素。
细绳 返回列表中位于指定游标之前的元素。
第一的 返回第一个N列表中的元素。
去年 返回最后一个N列表中的元素。

员工 (员工

#请求员工,但将其自定义VieldValues限制为特定的自定义领域。#当您对员工只获取特定的#自定义VieldValues时,可以使用自定义IDS参数。{员工(ID:20){customFieldValues(customFieldIds:[resourtnfird_contact“,”收藏夹_food“)){customfield {id fieldtytype} value}}}}}
#请求雇员并限制其signatureRequests那些正在等待签名或正被处理{雇员(ID:20){signatureRequests(状态:[WAITING_FOR_SIGNATURE,BEING_PROCESSED]){counterSigner {ID电子邮件}文件{fileUrl} signatureRequestTemplate {publicName}}}}

船上员工记录

争论 类型 描述 必需的
ID

雇员 (雇用雇员

#请求只有具有“客户经理”标题的员工。对于适合标准的每个员工,#返回其ID和电子邮件{员工(第一个:25,TitleFilter:{Titles:[“帐户管理器”]}){PAPEINFO {HASNextPage Endcursor} Edges {node {id email}}}}
#请求只要求那些有部门集(部门不是空的)的员工。对于适合标准的每个员工,#返回其ID和电子邮件{员工(第一:25,DepartmenFilter:{AnyValue:True}){PAPINFO {HASNextPage Endcursor} Edges {node {email}}}}
#请求只要求那些缺乏部门(部门为NULL)的员工。对于适合标准的每个员工,#返回他们的ID和电子邮件{员工(第一:25,DepartmenFilter:{novalue:true}){papinfo {hasnextpage endcursor}边缘{node {email}}}
#请求仅在2017-03-25和2018-03-25之间具有初始员工的员工。# These dates are exclusive (e.g. someone who started on 2017-03-25 or 2018-03-25 would not be included. { employees(first: 25, startDateFilter: { dateFilter: { after: "2017-03-25", before: "2018-03-25" } }) { pageInfo { hasNextPage endCursor } edges { node { id email startDate } } } }
#请求只要求那些为“收藏夹”自定义字段设置值(任何值)的员工。对于这些员工,返回所有自定义ValifeValues。{员工(第一:25,自定义VieldValues:[{ID:“收藏夹_Food”}“){PAPEINFO {HASNextPage Endcursor}边缘{node {id}}}}
#要求只为他们的“最喜欢的_Food”自定义领域设置有“热狗”或“鸡块”的员工。#因为“收藏夹”自定义字段是文本类型,我们提供“textvalues”参数(而不是#datevalues或didvalues){employees(首先:25,customfieldFieldValues:[{ID:“收藏夹”,TextValues:[“热狗“,”鸡块“]}]){pageinfo {hasnextpage endcursor}边缘{node {customfieldvalues {customfield {id} value}}}}}}}}}}}}}})
#请求只要求那些为他们的“收藏夹”自定义字段和“Blue”设置为其#“收藏品”自定义字段的值的员工。对于每个员工,返回其ID和电子邮件地址。{员工(第一:25,customfieldValues:[{id:“收藏夹:”fouts_food“},{id:”prestifty_color“,textvalues:[blue”]}]){papeinfo {hasnextpage endcursor}边缘{node {id email}}}}
#请求具有为“收藏夹”自定义字段设置值的员工。返回每个员工的ID和#自定义VieldValues,但只返回“收藏夹_food”customfield的自定义VieldValue。{员工(第一:25,CustomFieldValues:[{ID:“收藏夹_Food”}“){PAPEINFO {HASNextPage Endcursor}边缘{node {id自定义fieldValesvalues(customfieldIds:[”收藏夹_food“]){customfield {id} value}}}}}}}}}}
#,对于#“1_year_anniversary”自定义字段有“2017年4月13日”和“2018年4月13日”(不含)之间的日期值要求的员工。对于这些员工,返回其ID和#(此自定义字段,只值)为“1_year_anniversary”自定义字段中的值。{雇员(第一:25,customFieldValues:[{ID: “1_year_anniversary”,则DateValue:{之后: “2017年4月13日”,之前: “2018年4月13日”}}]){pageInfo {hasNextPage endCursor}边缘{节点{ID customFieldValues(customFieldIds:[ “1_year_anniversary”]){的CustomField {ID}}值}}}}
#请求具有员工35或员工40的员工设置为“Mentor”自定义字段的值。对于每个员工,返回他们的身份证,电子邮件地址和“关于我”的文本。{员工(第一:25,自定义VieldValues:[{ID:“Mentor”,Idvalues:[35,40]}]){PAPEINFO {HASNextPage Endcursor} Edges {node {id email aboud}}}}

船上员工记录的集合。以下参数被纾缓,应避免,因为将删除对它们的支持:DateFabrith,Departments,电子邮件,雇佣机构,HRManagerID,LocationID,ManagerID,WallueMails,StartDate,标题和工作组。这些参数中的每一个都有一个较新的,更强大的伴侣名为* filter。例如,DemputerIDS已被参数部门Filter替换 - 这允许提供部门ID的规范,但也允许更灵活性(例如,通过缺少/存在给定字段来过滤 - 而不是通过特定值过滤)。

争论 类型 描述 必需的
细绳 返回指定光标后的列表中的元素。
细绳 返回列表中位于指定游标之前的元素。
createdAt DateTimefilter. 根据创建时的过滤员工
自定义VielfValues. (CustomFieldValuesInput) 通过自定义字段值过滤员工
出生日期 datefilter 弃用。使用dateOfBirthFilter而不是
dateOfBirthFilter dateofbiftfilter 通过他们的出生日期过滤员工
Departmenfilter. DepartmentFilter 根据部门筛选员工
Departments. [int] 弃用。使用DeparyFilter
EmailFilter. EmailFilter 通过电子邮件过滤员工
电子邮件 [细绳] 弃用。使用EmailFilter
雇佣ratusfilter. 雇佣ratusfilter. 通过他们的就业状况过滤员工
employmentStatuses [细绳] 弃用。使用雇员静态Filter
第一的 返回第一个N列表中的元素。
hrmanagerfilter. HrManagerFilter 通过他们的人力资源经理过滤员工
hrmanagerids. [int] 弃用。使用hrmanagerfilter
去年 返回最后一个N列表中的元素。
locationFilter LocationFilter 通过他们的位置过滤员工
位置IID. [int] 弃用。使用positionFilter
管理员 管理员 通过他们的经理过滤员工
管理者 [int] 弃用。使用managerFilter而不是
PersonalEmailfilter. PersonalEmailfilter. 通过员工的私人邮件过滤他们
个人恐怖 [细绳] 弃用。使用WilderEemailfilter
开始日期 datefilter 弃用。使用startDateFilter而不是
startdatefilter startdatefilter 通过他们的开始日期过滤员工
titleFilter TitleFilter. 通过他们的头衔过滤员工
标题 [细绳] 弃用。使用titlefilter
updatedat. DateTimefilter. 基于人的上次更新过滤员工
Workcountrycodefilter Workcountrycodefilter 通过他们的工作国家代码过滤员工
Workcountrycodes. [细绳] 弃用。使用workcountrycodefilter

employmentStatuses ([细绳]

就业状态有效选项清单

地点 (位置

单个地点

争论 类型 描述 必需的
ID

位置(LocationConnection.

所有地点

争论 类型 描述 必需的
细绳 返回指定光标后的列表中的元素。
细绳 返回列表中位于指定游标之前的元素。
第一的 返回第一个N列表中的元素。
去年 返回最后一个N列表中的元素。

其他克星(OtherCriterionConnection

所有其他标准

争论 类型 描述 必需的
细绳 返回指定光标后的列表中的元素。
细绳 返回列表中位于指定游标之前的元素。
第一的 返回第一个N列表中的元素。
去年 返回最后一个N列表中的元素。

其他方法(其他

单个其他标准

争论 类型 描述 必需的
ID

Ratelimit(Ratelimit.

有关您当前API配额的信息

团队 (团队

一个团队

争论 类型 描述 必需的
ID

Team类别(TeamCategoryConnection.

所有团队类别

争论 类型 描述 必需的
细绳 返回指定光标后的列表中的元素。
细绳 返回列表中位于指定游标之前的元素。
第一的 返回第一个N列表中的元素。
去年 返回最后一个N列表中的元素。

TeamCategory(TeamCategory

单一团队类别

争论 类型 描述 必需的
ID

团队(团队连接

所有团队

争论 类型 描述 必需的
细绳 返回指定光标后的列表中的元素。
细绳 返回列表中位于指定游标之前的元素。
第一的 返回第一个N列表中的元素。
去年 返回最后一个N列表中的元素。

突变

adddepartment(adddepartmentpayload.

添加新部门

争论 类型 描述 必需的
addDepartmentInput adddepartmentInput! 必需的

添加位置 (AddLocationPayload.

添加一个新位置

争论 类型 描述 必需的
AddLocationInpul. AddLocationInpul! 必需的

addPendingHire (penninghire.

#创建一个PendingHire,包含必需的信息以及一个文本自定义字段的值(长文本,可确认,#和multiple_choice自定义字段也将字符串作为“值”)。突变{addPendingHire (pendingHireInfo: {firstName:“乔”姓:“笨蛋”电子邮件:“joe123@example.com”workCountryCode:“美国”customFieldValues: [{customFieldId:“favorite_food”价值:“鸡蛋松饼 " } ] } ) { firstName lastName邮件workCountryCode customFieldValues (customFieldIds: [" favorite_food "]) {customField {id}值}}}
#使用所需信息以及多个选择自定义字段的值创建挂起。这些自定义#字段需要JSON数组格式的字符串(包括“值”)的字符串(包括转义引号)。另请注意,数组中的每个#元素必须是给定自定义字段的有效选项。突变{addpendinghire(pendinghireinfo:{firstname:“joe”lastname:“schmoe”电子邮件:“Joe123@example.com”Workcountrycode:“USA”自定义VielfValues:[{CustomFieldId:“必填块:”必填_设备“,值:”[\“符合人体工程学键盘\“,”常设桌面“]”}]}){FirstName LastName电子邮件Workcountrycode自定义VieldValues(CustomFieldID:[“必填项”]){customfield {id}值}}}}
#使用所需信息以及团队自定义字段的值创建一个挂单。这些自定义字段#需要“值”的ID。突变{addpendinghire(pendinghireinfo:{firstname:“joe”lastname:“schmoe”电子邮件:“Joe123@example.com”Workcountrycode:“USA”自定义VieldValues:[{CustomFieldId:“Primary_social_club”,value:14}]}){firstNameLastName电子邮件WorkCountrycode CustomFieldValues {customfield {id}值}}}}}}}}}}}
#使用所需信息以及地址自定义字段的值创建待定艇。这些自定义#字段需要JSON对象格式的字符串(包括“值”)的字符串(包括转义引号)。变异{addpendinghire(pendinghireinfo:{firstname:“joe”lastname:“schmoe”电子邮件:“Joe123@example.com”Workcountrycode:“USA”自定义Values:[{CustomFieldId:“地址”,值:“{\”add​​ress_line_1 \“:\“123测试街”,\“address_line_2 \”:\“公寓1 \”,\“city \”:\“pawnee \”,\“state \”:\“in \”,\“zipcode \“:”12345“,\”国家/地区“:\”USA \“}”}“}){FirstName LastName电子邮件WorkCountryCode自定义VieldValues(自定义IID:[”地址“]){customfield {id} value}}}
#使用所需信息以及联系自定义字段的值创建挂单。这些自定义#字段需要JSON对象格式的字符串(包括“值”)的字符串(包括转义引号)。突变{addpendinghire(pendinghireinfo:{firstname:“joe”lastname:“schmoe”电子邮件:“joe123@example.com”Workcountrycode:“USA”自定义Vielfvalues:[{customfieldId:“Erroution_Contact”,Value:“{\”first_name \“:\“joe \”,\“last_name \”:\“schmoe \”,\“电子邮件\”:\“jschmoe@aol.com \”,\“phone \”:\“123.456.7890 \”,\“关系”:\“其他\”}“}”}){FirstName LastName电子邮件Workcountrycode自定义VieldValues(CustomFieldIDS:[“ErroutionFortact”]){customfield {id}值}}}}}
#使用所需信息以及日期自定义字段的值创建挂起。这些自定义字段#需要格式化的字符串:yyyy-mm-dd。突变{addpendinghire(pendinghireinfo:{firstname:“joe”lastname:“schmoe”电子邮件:“Joe123@example.com”Workcountrycode:“USA”自定义Values:[{CustomFieldID:“完全_投资”,价值:“2019-12-12”}]}){FirstName LastName电子邮件WorkCountryCode自定义VieldValues(CustomFieldIDS:[“完全_vested”]){customfield {id}值}}}

将待租用的挂起租用为温室188bet安卓APP

争论 类型 描述 必需的
Pendinghireinfo. addpendinghireinput! 必需的

deletedepartment(deletedepartmentpayload.

删除部门

争论 类型 描述 必需的
deletedepartmentInput. deletedepartmentinput! 必需的

deleteLocation(deletelocationPayload.

删除位置

争论 类型 描述 必需的
DeletelocationInpul. DeletelocationInpul! 必需的

更新(UpdateDepartmentPayload

更新一个部门

争论 类型 描述 必需的
UpdatedepartmentInput. updatedepartmentInput! 必需的

UpdateEmployeeProfile(员工

#更新员工的电子邮件地址,出生日期和部门。返回这些字段以确认更改。突变{updateEmployeeprofile(ID:25,employeeUpdates:{email:“new_email_address@example.com”dateofbirth:“部门:1}){电子邮件DateObirth部门{id}}}
#更新/创建文本,长文本,确认或多个_Chonoice自定义字段的值。对于#这些类型的自定义字段,为该值提供字符串。在这里,我们将“收藏夹”自定义字段值(文本自定义#字段)更新为“egmmuffins”。我们要求员工的自定义VieldValues,但是我们将它们限制在其中#属于“收藏品”自定义字段。例如。我们过滤掉无关的自定义VieldValues。突变{UpdateMployeEprofile(ID:20,employeeUpdates:{customFieldValues:[{customFieldId:“收藏品_food”,值:“eggcmuffins”}“)}){customfieldValues(customFieldValues(CustomFieldIds:[”收藏夹:[Frees_Food“)} {customfield {id}值}}}
#更新/创建多个选择自定义字段的值。对于这些自定义字段,“值”必须是表示JSON数组的String#(包括转义引号)。另外,此阵列的每个值必须#是给定自定义字段的预定义值之一。在这里,我们将“Resess_equipment”自定义字段值#设置为包含“符合人体工程学键盘”和“站立桌面”。然后,我们请求更新的员工对此自定义字段#以确认更改。突变{updateEmployeEprofile(ID:20,employeeUpdates:{customFieldValues:[{customFieldId:“必填项),值:”[\“符合人体工程学键盘\”,\“站立桌面”]“}”}){customFieldValues(自定义ID(CustomFieldIds:[“必填_设备”]){customfield {id fieldtytype}值}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}}
#更新/创建团队自定义字段的值。对于类型“团队”类型的自定义字段,我们提供ID作为#值。此值代表新团队的ID。在这里,我们将此员工“Primary_social_club”更改为#Team 14.可以通过利用团队查询来找到这些团队ID。突变{UpdateMployEePrefile(ID:20,empormeEupdates:{customFieldValues:[{customFieldId:“primary_social_club”,value:14})}){customfieldValues(customFieldValues(customFieldDIDS:[“Primary_social_club”)){customfield {id fieldtytype} value}}}}}}
#更新/创建地址自定义字段的值。这些自定义字段需要字符串值。此字符串值#必须是JSON对象(带引号相应传播)。突变{updateMenceEleprofile(ID:20,employeeUpdates:{customFieldValues:[{customFieldId:“地址”,值:“{\”add​​ress_line_1 \“:\”123测试街\“,\”add​​ress_line_2 \“:\”Apartment 1““,”城市“:\”Pawnee \“,\”州“:\”in \“,\”zipcode \“:\”12345 \“,\”country \“:\”美国\“}“}]}){customfieldValues(自定义IID:[”地址“]){customfield {id}值}}}
#更新/创建联系人自定义字段的值。这些自定义字段需要字符串值。此字符串值#必须是JSON对象(带引号相应传播)。突变{UpdateEmployeEprofile(ID:20,employeeUpdates:{customFieldValues:[{customFieldId:“Excormence_Contact”,Value:“{\”First_Name \“:\”Joe \“,\”Last_Name \“:\”Schmoe \“,\“电子邮件\”:\“jschmoe@aol.com \”,\“phone \”:\“123.456.7890”,\“关系”:\“其他\”}“}”}){customFieldValues(自定义IID:[ “emergency_contact”]){的CustomField {ID字段类型}值}}}
更新/创建日期自定义字段的值。这些定制字段需要一个字符串格式是这样的:{updateEmployeeProfile YYYY-MM-DD突变(id: 20, employeeUpdates: {customFieldValues: [{customFieldId:“fully_vested”价值:“2019-12-12 " } ] } ) { customFieldValues (customFieldIds: [" fully_vested "]) {customField fieldType {id}值}}}
#终止雇员。无论就业状况和终止日期是必需的。#终止日期可以在过去,应立即终止或将来。突变{updateEmployeeProfile(ID:20,employeeUpdates:{employmentStatus: “终止” customFieldValues:{customFieldId: “system.date_of_termination” 值: “2020年1月1日”}}){ID employmentStatus dateOfTermination}}

更新员工的个人资料

争论 类型 描述 必需的
employeeUpdates UpdateEmployee! 必需的
ID ID! 必需的

UpdatElocation(UpdatelocationPayload.

更新位置

争论 类型 描述 必需的
UpdatelocationInput. UpdateLocationInput! 必需的

类型

adddepartmentpayload.

运行adddepartment突变的结果

场地 类型 描述
新部

AddLocationPayload.

运行addLocation突变的结果

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

ComplexityInfo

关于当前请求复杂性的信息。如果复杂性超过最大限度,请求将失败

场地 类型 描述
最大 int!
分数 int!

国家

一个国家

场地 类型 描述
国家代码 细绳!
的名字 细绳!
状态 [状态!]!

的CustomField

代表您公司的单个自定义字段记录。可以以各种方式存储和显示自定义字段。通过该类型描述custom fieldtypes.枚举。

场地 类型 描述
createdAt 约会时间!
自定义菲尔德组 CustomFieldGroup
FieldType. CustomFieldType! 字段类型确定用户如何输入和查看数据该字段。
ID 细绳! 此自定义域的唯一标识符。
multipleChoiceOptions (字符串!]
的名字 细绳! 此自定义字段的名称,因为用户将在船上看到温室内。188bet安卓APP
TeamCategory. TeamCategory
updatedat. 约会时间!

CustomFieldConnection.

customfield的连接类型。

场地 类型 描述
边缘 [customfieldedge] 边的列表。
节点 [的CustomField] 节点列表。
PageInfo. PageInfo! 信息以帮助分页。

CustomFieldEdge

连接中的边缘。

场地 类型 描述
光标 细绳! 用于分页的游标。
节点 的CustomField 边缘末尾的项目。

CustomFieldGroup

一组自定义字段

场地 类型 描述
ID ID!
的名字 细绳!

CustomFieldValue.

自定义字段值记录

场地 类型 描述
createdAt 约会时间!
Customfield. 定制!
updatedat. 约会时间!
价值 价值 将基于现场类型存储不同类型的值的CustomField.某些类型使数据存储为嵌套对象。请注意,该类型是标识的标量价值.尽管这似乎是一个对象,你是不是能够使用GraphQL来确定它的形状。
ValueUpdateDat. 约会时间! 此字段最新更新的时间。

deletedepartmentpayload.

运行删除遗断突变的结果

场地 类型 描述
deleteddepartmentid. ID 刚删除的部门的身份证

deletelocationPayload.

运行DeletElocation突变的结果

场地 类型 描述
deletedLocationId ID 刚删除的位置的ID

代表贵公司的单一部门。员工可能属于零或一个部门。部门以各种方式用于温室onboared,包括权限和船上计划。188bet安卓APP

场地 类型 描述
createdAt 约会时间!
部门 员工
描述 细绳
电子邮件 细绳
细绳
ID ID!
的名字 细绳!
updatedat. 约会时间!

DepartmentConnection

部门的连接类型。

场地 类型 描述
边缘 [部门合格] 边的列表。
节点 [部] 节点列表。
PageInfo. PageInfo! 信息以帮助分页。

部门遵循

连接中的边缘。

场地 类型 描述
光标 细绳! 用于分页的游标。
节点 边缘末尾的项目。

文档

表示附加的单个文档员工

场地 类型 描述
createdAt 约会时间!
文件 文件 包含文件有效载荷。
ID ID!
updatedat. 约会时间!

员工

一个为你的公司工作的员工。员工有第一类字段(例如title, start_date, email),他们还为用户定义的自定义字段保存custom_field_values。这些辅助值保存在customFieldValues数组中。

场地 类型 描述
关于 细绳 员工的简要描述。此信息显示在员工的个人资料中,并在向本员工报告的任何新员工的欢迎体验中占据突出。
createdAt 约会时间!
自定义VielfValues. [custom fieldvalue!] 此员工的所有其他配置文件信息的列表。管理员可以在这些字段上配置这些字段设置>自定义字段页。
出生日期 日期 请注意,只有管理员只有员工看到诞生年份
dateoftermination. 日期 此信息仅在终止员工上提供
文档 (文档!] 这些是从温室招募或直接附加到员工档案的文件。188bet安卓APP118金博宝这有点包括电子签名请求。
电子邮件 细绳 员工的工作电子邮件。他们需要这个来签到
就业状况 细绳 有效的选项
firstName 细绳
188bet安卓AP118金博宝PGreenhouserecruitingData. 188bet安卓AP118金博宝PGreenhouserecruitingData. 温室招聘188bet安卓APP118金博宝“聘用”Webhook数据
人力资源经理 员工 员工的人力资源经理。
ID ID!
细绳
位置 位置
经理 员工 这个员工的直接经理。
middleName 细绳
其他 [OtherCriterion !]
私人邮箱 细绳 员工的个人电子邮件。
phoneNumber 细绳
首选义士游戏 细绳 这是您的员工更喜欢通过的名称。如果设置此值,则温室内的温室将在产品中无处不188bet安卓APP在,而不是员工的法律名称显示此名称。
profectslastname. 细绳 这是您的员工更喜欢通过的名称。如果设置此值,则温室内的温室将在产品中无处不188bet安卓APP在,而不是员工的法律名称显示此名称。
profileImage 文件 包含员工的个人资料图像的文件。此图像显示在电子邮件,报告和目录页面中。
signatureRequests [SignatureRequest!] 这些是通过温室启动的电子签名请求。188bet安卓APP请记住,这些请求可以在其生命周期中有许多不同的状态,并且可能并不总是可以下载签名文档。
开始日期 日期
后缀 细绳
标题 细绳 员工的职称。
updatedat. 约会时间!
workCountryCode 细绳!

雇用雇员

员工的连接类型。

场地 类型 描述
边缘 [员工展] 边的列表。
节点 [员工] 节点列表。
PageInfo. PageInfo! 信息以帮助分页。

员工证明

连接中的边缘。

场地 类型 描述
光标 细绳! 用于分页的游标。
节点 员工 边缘末尾的项目。

文件

文件记录

场地 类型 描述
Expiresat 约会时间 URL将过期的时间。在此之后,您需要生成新的URL。
文件名 细绳 文件的原始名称。
文件大小 文件大小,以字节为单位
fileurl. 细绳 您可以用来下载该文件的到期的URL。

188bet安卓AP118金博宝PGreenhouserecruitingData.

188bet安卓APP118金博宝温室招聘“候选人聘用”Webhook数据

场地 类型 描述
applicationid. ID! 188bet安卓APP温室招聘应用程序ID118金博宝
原始数据 细绳! 188bet安卓APP118金博宝温室招聘“候选人雇用”Webhook有效载荷

位置

代表您公司的一个位置。员工可能属于零或一个位置。位置以各种方式用于温室onboarding,包括权限和船上计划。188bet安卓APP

场地 类型 描述
地址 细绳
createdAt 约会时间
描述 细绳
电子邮件 细绳
细绳
ID ID
locallead. 员工
的名字 细绳
updatedat. 约会时间

LocationConnection.

连接类型的位置。

场地 类型 描述
边缘 [位置化] 边的列表。
PageInfo. PageInfo! 信息以帮助分页。

位置指望

连接中的边缘。

场地 类型 描述
光标 细绳! 用于分页的游标。
节点 位置 边缘末尾的项目。

突变

场地 类型 描述
adddepartment. adddepartmentpayload. 添加新部门
添加位置 AddLocationPayload. 添加一个新位置
addPendingHire penninghire. 将待租用的挂起租用为温室188bet安卓APP
Deletedopartment. deletedepartmentpayload. 删除部门
deletelocation. deletelocationPayload. 删除位置
updateDepartment UpdateDepartmentPayload 更新一个部门
updateEmployeePrefile. 员工 更新员工的个人资料
updateLocation UpdatelocationPayload. 更新位置

其他

可用于改进船上计划的标签

场地 类型 描述
createdAt 约会时间
ID ID
的名字 细绳
updatedat. 约会时间

OtherCriterionConnection

用于其他克明的连接类型。

场地 类型 描述
边缘 [其他] 边的列表。
PageInfo. PageInfo! 信息以帮助分页。

OtherCriterionEdge

连接中的边缘。

场地 类型 描述
光标 细绳! 用于分页的游标。
节点 其他 边缘末尾的项目。

PageInfo.

有关连接中分页的信息。

场地 类型 描述
endcursor 细绳 在闲暇前进时,光标继续。
hasnextpage. 布尔! 在闲暇前进时,有更多的物品吗?
hasPreviousPage 布尔! 向后闲暇时,有更多的物品吗?
startCursor 细绳 在向后划分时,光标继续。

penninghire.

待租用记录

场地 类型 描述
关于 细绳
createdAt 约会时间
自定义VielfValues. (CustomFieldValue)
出生日期 日期
电子邮件 细绳
就业状况 细绳 有效的选项
firstName 细绳
人力资源经理 员工
ID ID
细绳
位置 位置
经理 员工
私人邮箱 细绳
phoneNumber 细绳
首选义士游戏 细绳
profectslastname. 细绳
开始日期 日期
标题 细绳
updatedat. 约会时间
workCountryCode 细绳

Ratelimit.

有关您当前API配额的信息

场地 类型 描述
成本 这个查询的成本。这个金额从你以前的配额中扣除了。
限制 您的定额为给定期。
其余的 您的配额的剩余余额。任何超过此值的呼叫都将扼杀。
resetat. 约会时间 配额被重设为最大值的时间。

SignatureRequest

用于分配给的电子签名请求员工

场地 类型 描述
COUNTERSIGNER. 员工 如果适用,负责签署本文件的员工。
createdAt 约会时间
文件 文件 这只适用于已完成的签名。
ID ID
signatureequesttemplate. signatureRequesttemplate!
地位 signatureequeststatus.
updatedat. 约会时间

SignatureRequestTemplate

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

场地 类型 描述
COUNTERSIGNER. 员工 如果适用,负责从此模板创建的签名文件的默认员工。个人SignatureRequest对象可以覆盖计数器签名者。
createdAt 约会时间
的名字 细绳 模板的名称。这是管理员将看到的标签。
公共名称 细绳 面向模板的公开名称。这是新雇用将看到的名称。如果这是null,则新员工将看到名称字段。
updatedat. 约会时间

状态

一个状态

场地 类型 描述
国家 国家
的名字 细绳
statecode. 细绳

团队

一组记录

场地 类型 描述
描述 细绳
电子邮件 细绳
ID ID
位置 细绳
的名字 细绳
TeamCategory. TeamCategory

TeamCategory

A团队组别纪录

场地 类型 描述
ID ID
的名字 细绳

TeamCategoryConnection.

TeamCategory的连接类型。

场地 类型 描述
边缘 [TeamCategoryEdge] 边的列表。
PageInfo. PageInfo! 信息以帮助分页。

TeamCategoryEdge

连接中的边缘。

场地 类型 描述
光标 细绳! 用于分页的游标。
节点 TeamCategory 边缘末尾的项目。

团队连接

团队的连接类型。

场地 类型 描述
边缘 [TeamEdge] 边的列表。
PageInfo. PageInfo! 信息以帮助分页。

Compeed

连接中的边缘。

场地 类型 描述
光标 细绳! 用于分页的游标。
节点 团队 边缘末尾的项目。

UpdateDepartmentPayload

运行updateDepartment突变的结果

场地 类型 描述
更新的部门

UpdatelocationPayload.

运行UpdateLocation突变的结果

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

输入对象

AddDepartmentInput

用于添加的输入对象

争论 类型 描述 必需的
部门 ID
描述 细绳
电子邮件 细绳
细绳
的名字 细绳

AddLocationInpul.

用于添加的输入对象位置

争论 类型 描述 必需的
地址 细绳
描述 细绳
电子邮件 细绳
细绳
locallead. ID
的名字 细绳

AddPendingHireInput

指定新的待遇的属性

争论 类型 描述 必需的
关于 细绳
自定义VielfValues. [updatecustomfieldValue]
出生日期 日期
ID
电子邮件 细绳
就业状况 细绳 有效的选项
firstName 细绳! 必需的
人力资源经理 ID
细绳! 必需的
位置 ID
经理 ID
middleName 细绳
私人邮箱 细绳
phoneNumber 细绳
首选义士游戏 细绳
profectslastname. 细绳
开始日期 日期
后缀 细绳
标题 细绳
workCountryCode 细绳! 必需的

自定义ValuesInput.

将员工限制为满足指定的自定义范围标准的员工。注意:属于自定义字段的自定义VieldValues,其具有“Masked”的“蒙版”,不通过TextValues来过滤

争论 类型 描述 必需的
dateValue datefilter
ID 细绳! 必需的
Idvalues. [int]
textValues [细绳]

datefilter

使用(独占>),(独占<)或ON(完全匹配)指定一系列使用范围的日期

争论 类型 描述 必需的
日期
日期
日期

dateofbiftfilter

根据其出生日期过滤员工

争论 类型 描述 必需的
anyvalue. 布尔
datefilter datefilter
没有价值 布尔

DateTimefilter.

之前(独占<)以后指定一系列数据时(独占>)

争论 类型 描述 必需的
约会时间
约会时间

deletedepartmentInput.

用于删除A的输入对象

争论 类型 描述 必需的
ID ID! 必需的

DeletelocationInpul.

用于删除A的输入对象位置

争论 类型 描述 必需的
ID ID! 必需的

DepartmentFilter

根据部门筛选员工

争论 类型 描述 必需的
anyvalue. 布尔
Departments. [int]
没有价值 布尔

EmailFilter

过滤员工基于他们的电子邮件地址

争论 类型 描述 必需的
anyvalue. 布尔
电子邮件 [细绳]
没有价值 布尔

雇佣ratusfilter.

根据其就业状况过滤员工

争论 类型 描述 必需的
anyvalue. 布尔
employmentStatuses [细绳] 有效的选项
没有价值 布尔

HrManagerFilter

基于他们的人力资源经理过滤员工

争论 类型 描述 必需的
anyvalue. 布尔
hrmanagerids. [int]
没有价值 布尔

LocationFilter

根据员工所在的位置过滤员工

争论 类型 描述 必需的
anyvalue. 布尔
位置IID. [int]
没有价值 布尔

管理员

根据他们的经理过滤员工

争论 类型 描述 必需的
anyvalue. 布尔
管理者 [int]
没有价值 布尔

PersonalEmailfilter.

根据员工的个人电子邮件地址过滤员工

争论 类型 描述 必需的
anyvalue. 布尔
没有价值 布尔
个人恐怖 [细绳]

startdatefilter

根据他们的开始日期过滤员工

争论 类型 描述 必需的
anyvalue. 布尔
datefilter datefilter
没有价值 布尔

TitleFilter.

根据职位筛选员工

争论 类型 描述 必需的
anyvalue. 布尔
没有价值 布尔
标题 [细绳]

updatecustomfieldvalue.

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

争论 类型 描述 必需的
customFieldId. ID! 必需的
价值 价值

UpdatedepartmentInput.

用于更新a的输入对象

争论 类型 描述 必需的
部门 ID
描述 细绳
电子邮件 细绳
细绳
ID ID! 必需的
的名字 细绳

updateEmployee

用于更新对象的输入对象员工

争论 类型 描述 必需的
关于 细绳
自定义VielfValues. [updatecustomfieldValue]
出生日期 日期
ID
电子邮件 细绳
就业状况 细绳 有效的选项
firstName 细绳
人力资源经理 ID
细绳
位置 ID
经理 ID
middleName 细绳
其他 [ID]
私人邮箱 细绳
phoneNumber 细绳
首选义士游戏 细绳
profectslastname. 细绳
profileImage URL.
开始日期 日期
后缀 细绳
标题 细绳
workCountryCode 细绳

UpdatelocationInput.

用于更新a的输入对象位置

争论 类型 描述 必需的
地址 细绳
描述 细绳
电子邮件 细绳
细绳
ID ID! 必需的
locallead. ID
的名字 细绳

Workcountrycodefilter

根据其工作国家代码过滤员工

争论 类型 描述 必需的
anyvalue. 布尔
没有价值 布尔
Workcountrycodes. [细绳]

标量

布尔

代表真的要么错误的值。

日期

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

约会时间

ISO8601中DateTime的表示。

漂浮

表示标记的双重精度分数值,如下所示IEEE 754.

ID

表示一个唯一标识符,它是base64混淆。它通常用于将对象或作为缓存的键进行。ID类型以JSON响应显示为字符串;但是,它并非旨在是人类可读的。当预期作为输入类型时,任何字符串(例如“VXNlci0xMA ==”)或整数(例如4.)输入值将被接受为ID。

表示非分数签名的整个数值。int可以表示 - (2 ^ 31)和2 ^ 31 - 1之间的值。

细绳

表示文本数据作为UTF-8字符序列。GraphQL最常使用此类型以表示自由形式的人类可读文本。

URL.

一个url格式的字符串

价值

自定义字段值的实际值。这种类型能够握住两个字符串和整数。其内容将取决于其相应的自定义域的FieldType。

文字,long_text.

多项选择

multi_select.

团队

员工

地址

接触

日期

枚举

注意:枚举在用户输入中未引注,但在API输出中引用。

CustomFieldType

CustomFieldValues可能的类型值

价值 描述
地址 显示为输入组。存储为JSON。
接触 显示为输入组。存储为JSON。
日期 显示为DatePicker。存储为DateTime
员工 显示为员工下拉目。存储为员工ID。
long_text. 显示为多行文本框。存储为字符串。
掩盖 作为单行文本字段显示(在应用程序中隐藏)。存储为字符串。
多项选择 显示为下拉列表。存储为字符串。
multi_select. 显示为标签字段。存储为字符串数组。
团队 显示为团队的下拉列表。存储为团队ID。
文本 显示为单行文本字段。存储为字符串。

signatureequeststatus.

签名请求可能的状态值

价值 描述
正在处理 文档正在由我们的电子签名供应商处理。
取消 签名请求已终止。
完全的 文件已成功签署和验证。
错误 由于处理电子签名时,无法完成。
等待_for_counter_signature. 文件等待处于反签名者签名。
等待_for_signature. 等待员工签署文件。