Opportunity - Read – PORTERS Connect API Guide

Opportunity Read Method
Opportunity Read Sample

Opportunity Read Method

Opportunity APIは、Opportunity Resourceに対するアクセスを提供します。

Opportunity Readでは、指定した検索条件に対応するOpportunityのデータを取得することができます。

GET	https://{Request Host}/v1/opportunity?partition=*[value]&count=[value]&start=[value]&field=[value,...]&condition=[field=value,...]&itemstate=[value]&keywords=[value,...]&order=[value,...]*

Scope

Opportunity Readを行うために必要なアクセス権は次の通りです。

opportunity_r, recruiter_r, client_r, user_r, option_r

Input Variables

GETやPOST Methodを利用する場合、HTTP Headerのパラメータに値を指定する必要があります。詳細はHTTP Headerを参照してください。

また、指定できるParameterは以下の通りです。

Parameter間の条件はAND指定されたものとして検索されます。

必須	Parameter	Definition
●	partition	Partition Idを数値で指定します。アクセス可能なPartition Idを確認したい場合、Partition Readで取得してください。
ー	count	取得するデータの件数を数値で指定します。指定できる値の範囲は、1～200までです。省略した場合は10が指定されたものとみなします。
ー	start	取得するデータの開始インデックスです。0以上の値を数値で指定します。
ー	field	出力する項目を指定します。省略した場合はOpportunity.P_Idが指定されたものとみなします。詳細は、Read API - Parameter > Read - Fieldを参照してください。指定できるFieldは、Opportunity - Field Listを参照してください。
ー	condition	検索する条件を指定します。詳細は、Read API - Parameter > Read - Conditionを参照してください。指定できるFieldは、Opportunity - Field Listを参照してください。但し、itemstateにdeleted、または、allを指定する場合、conditionに指定できるFieldと条件は次の3種類です。尚、次の3種類の条件を複数指定することは可能です。 1．Opportunity.P_Id 2．Opportunity.P_UpdateDate 指定可能な値は、Request日時から90日前の同時刻までの間の値です。それ以前の日時を指定することはできません。省略した場合は、Request日時の90日前の同時刻が指定されたものとみなします。 3．Opportunity.P_UpdatedBy
ー	itemstate	取得するデータの状態を指定します。次の値を指定することができます。省略した場合は、existingが指定されたものとみなします。 existing：削除されていないデータを取得 deleted ：削除されたデータを取得 all ：すべての状態のデータを取得 ※itemstate=allとitemstate=deleted については更新日が90日以内という検索条件が自動で追加されます。（itemstate=existingとitemstateなしについては、上記の検索条件は追加されません。） ※deletedまたはallを指定した場合、conditionに指定できる条件に制限が発生します。
ー	keywords	取得するデータの条件をキーワードで指定します。詳細は、Read API - Parameter > Read - Keywordsを参照してください。
ー	order	出力時のデータの並び順を指定します。省略した場合は、Opportunity.P_Id:ascが指定されたものとみなします。詳細は、Read API - Parameter > Read - Orderを参照してください。指定できるFieldは、Opportunity - Field Listを参照してください。

Result Values

処理が成功した場合は、Response HeaderにHTTP Statusとして200が返り、Output Valuesで解説している値が取得できます。

エラーが発生した場合は、200以外の値が返ります。

Output Values

出力値はXML形式で取得できます。

Tag	Definition
Opportunity	条件に該当するOpportunityを含むルート要素です。取得できたデータの数がCountに、取得データのインデックスがStartに設定されます。Startは0から始まるインデックスです。 Opportunityの一つずつをItem要素として列挙します。
Total	Opportunityの属性。指定した検索条件で取得できる総件数を示します。
Count	Opportunityの属性。今回取得したデータの件数を示します。
Start	Opportunityの属性。今回取得したデータの開始インデックスを示します。
Code	処理結果を表すcodeです。詳細は、Result Code Listを参照してください。
Item	一つのOpportunity情報を表します。Field要素を持ちます。
Field	指定された項目の値を格納します。要素の名称は、Opportunity - Field Listを参照してください。

Opportunity Read Sample

※本サンプルでは、Encodeを行わずに記載しています。実際のRequest時には内容によってEncode/Decodeが必要です。

次のサンプルは、Opportunity ReadでIDを条件に指定して、商談管理 ID、ポジション、データ更新者を取得した場合の例です。

Input Parameter

https://{Request Host}/v1/opportunity?partition=999999&field=Opportunity.P_Id,Opportunity.P_Position,Opportunity.P_UpdatedBy(User.P_Id,User.P_Name)&condition=Opportunity.P_Id:or=1234:1235

Output XML

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<Opportunity Total="2" Count="2" Start="0">
<Code>0</Code>
<Item>
<Opportunity.P_Id>1234</Opportunity.P_Id>
　　<Opportunity.P_Position>テストポジション１</Opportunity.P_Position>
　　<Opportunity.P_UpdatedBy>
　　　<User>
　　　　<User.P_Id>1</User.P_Id>
　　　　<User.P_Name>テストエージェント1</User.P_Name>
　　　</User>
　　</Opportunity.P_UpdatedBy>
</Item>
<Item>
<Opportunity.P_Id>1235</Opportunity.P_Id>
　　<Opportunity.P_Position>テストポジション2</Opportunity.P_Position>
　　<Opportunity.P_UpdatedBy>
　　　<User>
　　　　<User.P_Id>2</User.P_Id>
　　　　<User.P_Name>テストエージェント2</User.P_Name>
　　　</User>
　　</Opportunity.P_UpdatedBy>
</Item>
</Opportunity>