機械翻訳について

ジャンプ先

• リクエスト
• レスポンス
• 例

ドキュメントの共有個人インスタンスを取得

get

/crmRestApi/resources/11.13.18.05/lightboxDocuments/{LightboxDocumentId}/child/sharedPersons/{sharedPersonsUniqID}

リクエスト

パス・パラメータ

• LightboxDocumentId(required): string
  Lightbox文書の一意の識別子。
• sharedPersonsUniqID(required): string
  これは、共有個人インスタンス・リソースのコンポジット・キーを構成し、共有個人インスタンスのインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントは、共有個人インスタンスの特定のインスタンスに移動してハッシュ・キーを取得するために、共有個人インスタンス・コレクション・リソースを問い合せる必要があります。

問合せパラメータ

• dependency: string
  このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
  
  フォーマット: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
• fields: string
  このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
  
  フォーマット : ?fields=Attribute1,Attribute2
  
  子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

この操作にはリクエスト本文がありません。

トップに戻る

応答

サポートされるメディア・タイプ

• application/json

デフォルトのレスポンス

次の表では、このタスクに対するデフォルトのレスポンスについて説明します。

ヘッダー

• Metadata-Context(required):
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

本文( )

ルート・スキーマ : lightboxDocuments-sharedPersons-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  レコードを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  レコードが作成された日付。
• DeleteFlag: boolean
  読取り専用: true

  現在のユーザーに共有個人レコードを削除する権限があるかどうかを示します。
• EmailAddress: string
  タイトル: Primary Email

  読取り専用: true

  最大長: 320

  文書が共有された個人のEメールID。
• IsJointOwnerFlag: boolean
  タイトル: Owner

  最大長: 1

  文書が共有されたパーティが文書の所有者の1人であるかどうかを示します。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  レコードを最後に更新したユーザー。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  レコードが最後に更新された日付。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのログイン。
• LightboxDocumentId: string
  タイトル: Document ID

  最大長: 64

  Lightbox文書の一意の識別子。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• OrganizationName: string
  タイトル: Organization

  読取り専用: true

  最大長: 240

  文書が共有された個人の組織名。
• PersonFirstName: string
  タイトル: First Name

  読取り専用: true

  最大長: 150

  文書が共有された個人の名。
• PersonLastName: string
  タイトル: Last Name

  読取り専用: true

  最大長: 150

  文書が共有された個人の姓。
• PersonName: string
  タイトル: Name

  読取り専用: true

  最大長: 450

  文書が共有された個人の名前。
• PersonTitle: string
  タイトル: Title

  読取り専用: true

  最大長: 60

  文書が共有された個人のタイトル。
• ReportsTo: string
  タイトル: Manager

  読取り専用: true

  最大長: 360

  文書が共有された個人のマネージャ。
• SharedDate: string (date-time)
  タイトル: Shared Date

  読取り専用: true

  文書が共有された日付。
• SharedUserPartyId: integer (int64)
  タイトル: Party ID

  文書が共有されたパーティの一意の識別子。

{
    "type":"object",
    "properties":{
        "OrganizationName":{
            "title":"Organization",
            "maxLength":240,
            "type":"string",
            "description":"The organization name of the person with whom the document was shared.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The date when the record was last updated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonName":{
            "title":"Name",
            "maxLength":450,
            "type":"string",
            "description":"The name of the person with whom the document was shared.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SharedDate":{
            "title":"Shared Date",
            "type":"string",
            "description":"The date when the document was shared.",
            "format":"date-time",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the person with whom the document was shared.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false,
            "x-queryable":true
        },
        "IsJointOwnerFlag":{
            "title":"Owner",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates if the party with whom the document has been shared is one of the owners of the document.",
            "nullable":true,
            "x-queryable":true
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the person with whom the document was shared.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "SharedUserPartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party with whom the document has been shared.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"Primary Email",
            "maxLength":320,
            "type":"string",
            "description":"The email ID of the person with whom the document was shared.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the current user has the permission to delete the shared person record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "DocumentStatusCode",
                    "IsOriginalOwnerRecord",
                    "MyDocumentOwnerFlag",
                    "SharedUserPartyId"
                ]
            }
        },
        "PersonTitle":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title of the person with whom the document was shared.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ReportsTo":{
            "title":"Manager",
            "maxLength":360,
            "type":"string",
            "description":"The manager of the person with whom the document was shared.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The user who last updated the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : リンク

タイプ: array

タイトル: Links

リソース・インスタンスに関連付けられたリンク関係。

ソースを表示

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

ネストされたスキーマ : リンク

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

  関連リソースへのURI。
• kind: string
  タイトル: kind

  許可された値: [ "collection", "item", "describe", "other" ]

  関連リソースの種類。
• name: string
  タイトル: name

  関連リソースへのリンクの名前。
• properties: object properties
• rel: string
  タイトル: relation

  許可された値: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

  リソース・インスタンスとの関係の名前。 例: self.

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

ネストされたスキーマ : properties

タイプ: object

ソースを表示

• changeIndicator: string
  リソース・インスタンスのインジケータまたはETag値を変更します。

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するGETリクエストを発行することによって、ドキュメントの共有個人インスタンスを取得する方法を示しています。

cURLコマンド

curl --basic --user user_name:passwd -X GET http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/lightboxDocuments/{lightboxDocumentID}/child/sharedPersons/{sharedPersonsUniqID}

レスポンス本文の例

次の例は、JSON形式のレスポンス本文のコンテンツを示しています:

{
  "LightboxDocumentId": "c8d23da1-587b-44f6-b35d-c43145eb19aa",
  "SharedUserPartyId": 100010032752839,
  "IsJointOwnerFlag": false,
  "SharedDate": "2016-10-20T04:30:17-07:00",
  "PersonName": "Boyle,Bob",
  "PersonFirstName": "Bob",
  "PersonLastName": "Boyle",
  "PersonTitle": null,
  "EmailAddress": "CEO.CRM+TM30@your_org.com",
  "ReportsTo": "Ellings,Oleif",
  "OrganizationName": "AMQA Norway Support ",
  "DeleteFlag": true,
  "CreationDate": "2016-10-20T04:30:17-07:00",
  "CreatedBy": "MHoope",
  "LastUpdateDate": "2016-10-20T04:30:17-07:00",
  "LastUpdatedBy": "MHoope",
  "LastUpdateLogin": "3F460044B34F1E7DE053DF00F40A6BE0",
...
}

「トップに戻る」