JS SDKライブラリ - Zoho People（カスタムウィジェットとウェブタブ）

JS SDKライブラリ - Zoho People（カスタムウィジェットとウェブタブ）

お知らせ：当社は、お客様により充実したサポート情報を迅速に提供するため、本ページのコンテンツは機械翻訳を用いて日本語に翻訳しています。正確かつ最新のサポート情報をご覧いただくには、本内容の英語版を参照してください。

JS SDKライブラリは、ウィジェットやWebタブでAPIリクエストに認証設定をせずにZoho Peopleからフォームデータを取得できるAPIセットです。他のZoho People APIを利用する場合は、外部連携の設定が必要です。詳しくは外部連携によるAPI呼び出しをご参照ください。

以下のSDKメソッドを呼び出す前に、JS SDKのURLをコード内に含めてください。
https://static。zohocdn。com/zp5/widgets/zpwidgetsdk。min。js
ウィジェットにリスナーを登録するには：
ウィジェットを初期化し、Zoho Peopleアプリケーション内の処理を監視するには、以下のコードスニペットを使用してください。
Zoho.embeddedApp。init();
サポート対象は関連リストおよびカスタムボタンウィジェットのみです。
ウィジェットが現在表示されているフォームIDを取得するには、以下を使用してください。
Zoho.People。API。getFormId()

レスポンス

String（データID）

form項目コンポーネントの取得

form項目コンポーネントを取得するには、以下を使用してください。
Zoho.People。API。getFormComponents(inputData)
inputData
JSON入力
{formName:<フォーム名>};

formNameについては、こちらを参照してください。


レスポンス
[{
'comptype': 'Text',
'ismandatory': 真,
'descriptionType': +10、-10,
'displayname': 'EmployeeID',
'autofillvalue': '',
'説明': '',
'formcomponentid': '115782000000020183',
'labelname': 'EmployeeID',
'maxLength': 100
}, {
'comptype': 'Text',
'ismandatory': 真,
'descriptionType': +10、-10,
'displayname': '姓',
'autofillvalue': '',
'説明': '',
'formcomponentid': '115782000000020187',
'labelname': 'LastName',
'maxLength': 100
}]

formデータの追加

formデータを追加するには、以下を使用します:
Zoho.People.API.addFormData(inputData);
 
inputData
JSON入力:
 
{formName:<フォーム名>, input:{LabelName:値, LabelName1:値}};

 formNameの参照は こちら

LabelNameの参照は こちら

 

レスポンス

完了レスポンス: データの追加に成功しました
失敗レスポンス: エラーが発生しました

formデータの更新

formデータを更新するには、次を使用してください:
Zoho.People.API.updateFormData(inputData);
 
inputData
JSON入力:
 
{formName:<フォーム名>, input:{LabelName:値, LabelName1:値},recordId: };

 formNameの参照は こちら

レスポンス

完了 Response: データが正常に更新されました
Failure Response: エラーが発生しました

取得する データID

関連リストおよびカスタムボタンウィジェットのみ対応しています。
ウィジェットが現在表示されているデータのデータIDを取得するには、以下を使用してください：
Zoho.People。API。getRecord()

データIDでフォームデータを取得する

データIDでフォームデータを取得するには、次を使用してください：
Zoho.People。API。getFormRecord(inputData):

 
inputData

JSON入力例: 

{recordId:<データID>,formName: <フォーム名>};
formNameの指定方法については こちらをご参照ください。

 

現在、formデータIDは Zoho.People。API。getRecord() で取得できます。

レスポンス

{'LabelName': 値, 'LabelName1':value2,'LabelName_downloadUrl':file アップロードする 項目 ダウンロードする url}

bulk form データの取得

bulk form データを取得するには、以下を使用します:
Zoho.People。API。getBulkRecords(inputData)
inputData



JSON 入力例：
 
{formName:<フォーム名>,startIndex:<開始位置>,limit:<取得件数>}


startIndex - 任意項目、初期値は -1
limit - 任意項目、初期値は 200

レスポンス

[{'LabelName': 値, 'LabelName1':value2,'LabelName_downloadUrl':file アップロードする 項目 ダウンロードする url}, {'LabelName': value1, 'LabelName1':value22,'LabelName_downloadUrl':file アップロードする 項目 ダウンロードする url},
]

formデータをセクションごとに取得

セクションごとにformデータを取得するには、以下を使用します。
Zoho.People。API。getFormDatabySection(inputData)
inputData
JSON入力例:
 
{formName: ,recordId:<データID>}

formNameについては こちら  を参照してください

レスポンス

[
{
'Section1': {
'ラベル名': 値, 'ラベル名': 値
},
'Section2': {
'ラベル名': 値, 'ラベル名': 値
},
'tabularSections': {
'ラベル名': [
{
'ラベル名': 値, 'ラベル名': 値
}
],
'ApprovalStatus': 'Approval Not 有効'
}
]

formファイルのダウンロード

formファイルをダウンロードするには、以下を使用します。
Zoho.People。API。downloadFormFile(inputData);
 
inputData
JSON入力例：
 
{fcId:,recordId:,formId:}

レスポンス

ファイル内容

file categoriesの取得

file categoriesを取得するには、次を使用します：
Zoho.People。API。getFileCategories();

レスポンス

[{'CatID':'1','CatName':'テスト'},{'CatID':'2','CatName':'Test1'}]

従業員ファイルのアップロード

ファイルをアップロードするには、次を使用します：
Zoho.People。API。uploadEmployeeFile(fileInput);
 
fileInput
JSON入力：
 
{uploadfile: , fileName: <ファイル名>, employeeId: ,fileDesc: <説明>,catId: };

catIdを取得するには、以下を使用してください：
Quote
Zoho.People。API。getFileCategories();

レスポンス


完了レスポンス：データが正常に追加されました

サードパーティAPIの呼び出し

サードパーティAPIを呼び出すには、以下を使用してください：
Zoho.People。Http。post(requestObj);
 
inputData
JSON 入力例:
 
var requestObj = {
url : url,
header: {'Authorization'':'Zoho-oauthtoken-__token'}
params: {};
};

Notes
Zoho-oauthはZoho サービスAPIの呼び出しに使用します。

レスポンス

APIからのレスポンスです。

外部連携を利用したAPI呼び出し

外部連携を利用してAPIを呼び出すには、以下を使用します:
Zoho.People.API.invokeUrl(requestData);
Zoho Peopleで外部連携を設定し、APIを外部連携経由で呼び出す方法については 外部連携 - Zoho People をご参照ください。
Zoho People APIの詳細については Zoho People API をご覧ください。
inputData






JSON入力

var input = {url: <呼び出すURL> ,
connectiondetails:'名前=<connection-名前> ',
params : <urlパラメーター> , // url パラメーター 任意
methodType: <GET|POST|PUT|DELETE>;
extraParam: <urlヘッダー> }; // url ヘッダー 任意
};


例 :
var input = {
url:'target_url',
connectiondetails: 'connection 名前',
method: 'POST',
apiParams : {
'id' : '12121212121212',
'名前' : 'john',
},
extraParam : {
'コンテンツの種類' : 'application/json'
},
};

レスポンス

APIからのレスポンス。

スタンドアロン関数の呼び出し

ウィジェットやWebタブでJS SDKを使用してスタンドアロン関数を呼び出すには、次を利用します:
関数は、Zoho Peopleの管理者または自動化管理権限を持つユーザーのみが呼び出せます。
Zoho.People.API.invokeStandaloneFunction(requestData);
InputData










JSON入力

var requestData = {
fnName : {Function 名前}*,
params : {引数をstringifyされたjson形式で渡す} - 任意
}

例:
var requestData = {
fnName : 承認する,
params : '{'名前':'kiran','num':'999','ステータス':'真'}'
}

レスポンス

完了レスポンス: {ステータス : 完了}
失敗レスポンス: エラーJson

現在のログインユーザー情報を取得

現在ログイン中のユーザー情報を取得するには、以下を使用します:
Zoho.People。API。getCurrUserInfo();

レスポンス

JsonObject

組織IDを取得

現在ログイン中の組織IDを取得するには、以下を使用します:
Zoho.People。API。getOrganizationId();

レスポンス

例: OrgId : 90120123

ウィジェットおよびWebタブのサンプルコード

フォームからデータを取得 - ウィジェット（RelatedListおよびカスタムボタン）

アプリケーション初期化のため、HTMLファイル内のすべてのJS SDK API呼び出しはZoho.embeddedApp。init()で囲んでください。
  8. <本文>

  9. これはフォームデータを取得するためのサンプルウィジェットです。


フォームからデータを取得 - Webタブ

HTMLファイル内のすべてのJS SDK API通話は、アプリケーションの初期化のためにZoho.embeddedApp。init()内に記述されていることを必ずご確認ください。
  8. <本文>

  9. これは、フォームデータを取得するサンプルウィジェットです。

1つのウィジェットで複数のSDK APIを使用する

IdeaHTMLファイル内のすべてのJS SDK API通話は、アプリケーションの初期化のためにZoho.embeddedApp。init()内に記述する必要があります。
  8. <本文>

  9. これは、form データを取得するためのサンプルウィジェットです。

JS SDKの外部連携サポートを利用したZoho People API通話の呼び出し方

アプリケーション初期化のため、HTMLファイル内のすべてのJS SDK API通話はZoho.embeddedApp。init()内に記述してください。
  8. <本文>

  9. これはフォームデータを取得するサンプルウィジェットです。

JS SDK API を利用する前に、まず Zoho.embeddedApp。init() の呼び出しを初期化してください。

ここでは、JS SDK API 関数 通話 が Zoho.embeddedApp。init() の外で実行されています。
  8. <本文>

  9. これは Zoho Extension Toolkit を使用して作成されたサンプルウィジェットです。