Oracle Fusion Cloud Customer ExperienceのSales and Fusion ServiceのREST API

機械翻訳について

ドキュメントの共有個人インスタンスの作成

post

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

リクエスト

パス・パラメータ

LightboxDocumentId(required): string

Lightbox文書の一意の識別子。

ヘッダー・パラメータ

Metadata-Context:

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

RESTクライアントとサービスの間のプロトコル・バージョン。クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。

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

application/json

次の表では、このタスクのリクエストの本文パラメータについて説明します。

ルート・スキーマ : スキーマ

タイプ: object

ソースを表示

IsJointOwnerFlag: boolean

タイトル: Owner

最大長: 1

文書が共有されたパーティが文書の所有者の1人であるかどうかを示します。
LightboxDocumentId: string

タイトル: Document ID

最大長: 64

Lightbox文書の一意の識別子。
SharedUserPartyId: integer (int64)

タイトル: Party ID

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

{
    "type":"object",
    "properties":{
        "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
        },
        "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
            }
        },
        "LightboxDocumentId":{
            "title":"Document ID",
            "maxLength":64,
            "type":"string",
            "description":"The unique identifier of the Lightbox document.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

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リソースに対するPOSTリクエストを発行して、ドキュメントの共有個人インスタンスを作成する方法を示しています。

cURLコマンド

curl --basic --user user_name:passwd -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -X POST -d '{"SharedUserPartyId":{sharedUserPartyId},"IsJointOwnerFlag":"false"}' http://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/lightboxDocuments/{lightboxDocumentID}/child/sharedPersons/

リクエスト本文の例

次に、JSON形式のリクエスト本文の例を示します。

{
"SharedUserPartyId":{sharedUserPartyId},"IsJointOwnerFlag":"false"
}

レスポンス本文の例

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

{
  "LightboxDocumentId": "c8d23da1-587b-44f6-b35d-c43145eb19aa",
  "SharedUserPartyId": 300100027398207,
  "IsJointOwnerFlag": false,
  "SharedDate": null,
  "PersonName": "EXTNAUTORUN_OSB EXTNAUTORUN_OSB",
  "PersonFirstName": "EXTNAUTORUN_OSB",
  "PersonLastName": "EXTNAUTORUN_OSB",
  "PersonTitle": null,
  "EmailAddress": "sendmail-test-discard@your_org.com???,
  "ReportsTo": null,
  "OrganizationName": null,
  "DeleteFlag": false,
  "CreationDate": "2016-10-20T23:21:01-07:00",
  "CreatedBy": "KRyan",
  "LastUpdateDate": "2016-10-20T23:21:03-07:00",
  "LastUpdatedBy": "KRyan",
  "LastUpdateLogin": "3F596D04CE2138CFE053DF00F40A383D",
 ...
}

「トップに戻る」