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

機械翻訳について

リソースの取得

get

/crmRestApi/resources/11.13.18.05/resources/{PartyNumber}

リクエスト

パス・パラメータ

PartyNumber(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のデフォルト・バージョンを選択します。

ルート・スキーマ : resources-item-response

タイプ: object

ソースを表示

CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

Who列: 行の作成ユーザーを示します。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

Who列: 行の作成日時を示します。
DeleteFlag: boolean

読取り専用: true

ユーザーがリソースを削除できるかどうかを示します。
EmailAddress: string

タイトル: E-Mail

読取り専用: true

最大長: 320

リソースのEメール・アドレス。
EndDateActive: 文字列(日付)

タイトル: To Date

このリソースがアクティブでなくなった日付。
FormattedAddress: string

タイトル: Address

読取り専用: true

最大長: 255

リソースのプライマリ書式化された住所情報。
FormattedPhoneNumber: string

タイトル: Phone

読取り専用: true

最大長: 100

リソースのプライマリ書式付き電話番号。
JobMeaning: string

タイトル: Job Title

読取り専用: true

従業員であるリソースのジョブ・タイトル。
LastUpdateDate: string (date-time)

タイトル: Last Updated

読取り専用: true

Who列: 行の最終更新日時を示します。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 64

Who列: 行の最終更新ユーザーを示します。
LastUpdateLogin: string

タイトル: Last Update Login

読取り専用: true

最大長: 32

Who列: 行を最後に更新したユーザーに関連付けられたセッション・ログインを示します。
links: array Links

タイトル: Links

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

タイトル: Manager

読取り専用: true

このリソースのマネージャの名前。
ManagerPartyId: integer

タイトル: Manager Party ID

リソースのマネージャ・パーティの一意の識別子。
PartyId: integer (int64)

タイトル: Resource

リソース・パーティの一意の識別子。
PartyName: string

タイトル: Resource Name

読取り専用: true

最大長: 360

リソース・パーティの名前。
PartyNumber: string

タイトル: Registry ID

読取り専用: true

最大長: 30

リソース・パーティの代替キー識別子。
PersonFirstName: string

タイトル: First Name

最大長: 150

リソースの名。
PersonLastName: string

タイトル: Last Name

最大長: 150

リソースの姓。
PersonLastNamePrefix: string

タイトル: Last Name Prefix

読取り専用: true

最大長: 30

リソースの姓のプレフィクス。
PersonMiddleName: string

タイトル: Middle Name

読取り専用: true

最大長: 60

リソースのミドル・ネーム。
PersonNameSuffix: string

タイトル: Suffix

読取り専用: true

最大長: 30

リソースの名前のサフィクス。
PersonPreNameAdjunct: string

タイトル: Salutary Introduction

読取り専用: true

最大長: 30

リソースの優先名前隣接。
PersonPreviousLastName: string

タイトル: Previous Last Name

読取り専用: true

最大長: 150

リソースの前の姓。
PersonSecondLastName: string

タイトル: Second Last Name

読取り専用: true

最大長: 150

リソースの2番目の姓。
PictureAttachment: array Picture Attachments

タイトル: Picture Attachments

画像添付リソースは、リソースの画像を表示するために使用されます。
PrimaryOrganization: string

タイトル: Organization

読取り専用: true

このリソースのプライマリ組織。
RecordSet: string

タイトル: Record Set

定義された条件に一致するリソースをグループ化するレコード・セット。
ResourceOrgRoleCode: string

読取り専用: true

最大長: 255

リソースに割り当てられたロールのコード値。
ResourceOrgRoleName: string

読取り専用: true

最大長: 255

組織または階層内のリソースの機能を定義するロール。
ResourceProfileId: integer (int64)

タイトル: Resource Profile ID

読取り専用: true

リソース・プロファイルの一意の主キー識別子。
ResourceType: string

タイトル: Usage

従業員などのリソースのタイプ。
StartDateActive: 文字列(日付)

タイトル: Effective As-of Date

リソースがアクティブになる日付。
UpdateFlag: boolean

読取り専用: true

ユーザーがリソースを更新できるかどうかを示します。
Url: string

タイトル: Primary URL

読取り専用: true

最大長: 2000

リソースのプライマリURL。
Usage: string

タイトル: Usages

リソース・パーティの読取り専用パーティ使用目的。
Username: string

タイトル: User Name

読取り専用: true

このリソースに関連付けられているユーザー・アカウントの名前

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"Who column: indicates the date and time of the creation of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceOrgRoleCode":{
            "maxLength":255,
            "type":"string",
            "description":"Code value for the role assigned to a resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceProfileId":{
            "title":"Resource Profile ID",
            "type":"integer",
            "description":"The unique primary key identifier for the resource profile.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "PersonLastNamePrefix":{
            "title":"Last Name Prefix",
            "maxLength":30,
            "type":"string",
            "description":"The prefix for the last name of a resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonLastNamePrefix",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Last Name Prefix"
            }
        },
        "PersonNameSuffix":{
            "title":"Suffix",
            "maxLength":30,
            "type":"string",
            "description":"The suffix for the name of a resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonNameSuffix",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Suffix"
            }
        },
        "PartyName":{
            "title":"Resource Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of a resource party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonMiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonMiddleName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Middle Name"
            }
        },
        "ManagerPartyId":{
            "title":"Manager Party ID",
            "type":"integer",
            "description":"The unique identifier of the resource???s manager party.",
            "nullable":true,
            "x-queryable":false
        },
        "Manager":{
            "title":"Manager",
            "type":"string",
            "description":"The name of the manager for this resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "Url":{
            "title":"Primary URL",
            "maxLength":2000,
            "type":"string",
            "description":"The primary URL of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"WebEO.Url",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"URL"
            }
        },
        "StartDateActive":{
            "title":"Effective As-of Date",
            "type":"string",
            "description":"Date on which the resource becomes active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "UpdateFlag":{
            "type":"boolean",
            "description":"Indicates if the user can update the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PrimaryOrganization":{
            "title":"Organization",
            "type":"string",
            "description":"The primary organization for this resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceOrgRoleName":{
            "maxLength":255,
            "type":"string",
            "description":"The role that defines the function of the resource in an organization or hierarchy.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonSecondLastName":{
            "title":"Second Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The second last name of a resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonSecondLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Second Last Name"
            }
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "maxLength":100,
            "type":"string",
            "description":"The primary formatted phone number for a resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "PrimaryPhoneContactPtId"
                ]
            }
        },
        "RecordSet":{
            "title":"Record Set",
            "type":"string",
            "description":"The record set that groups resources matching the defined criteria.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "JobMeaning":{
            "title":"Job Title",
            "type":"string",
            "description":"The job title for the resource who is an employee.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who last updated the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonPreNameAdjunct":{
            "title":"Salutary Introduction",
            "maxLength":30,
            "type":"string",
            "description":"The preferred name adjacency of a resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Usage":{
            "title":"Usages",
            "type":"string",
            "description":"The read-only party usage for the resource party.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"Who column: indicates the user who created the row.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PersonLastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the resource.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "PictureAttachment":{
            "title":"Picture Attachments",
            "type":"array",
            "description":"The picture attachments resource is used to view the picture of a resource.",
            "items":{
                "$ref":"#/components/schemas/resources-PictureAttachment-item-response"
            },
            "x-cardinality":"1"
        },
        "FormattedAddress":{
            "title":"Address",
            "maxLength":255,
            "type":"string",
            "description":"The primary formatted address information of a resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourceType":{
            "title":"Usage",
            "type":"string",
            "description":"The type of resource, such as employee.",
            "nullable":true,
            "x-queryable":false
        },
        "PersonFirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the resource.",
            "nullable":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"E-Mail",
            "maxLength":320,
            "type":"string",
            "description":"The e-mail address of a resource.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ],
                "dependencies":[
                    "PersonalEmailFlag"
                ]
            },
            "x-queryable":true
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the user can delete the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "PersonPreviousLastName":{
            "title":"Previous Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The previous last name of a resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PersonDEO.PersonPreviousLastName",
                "protectionObjectTitle":"Contact",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Previous Last Name"
            }
        },
        "PartyNumber":{
            "title":"Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier of the resource party.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"To Date",
            "type":"string",
            "description":"Date on which this resource is no longer active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Resource",
            "type":"integer",
            "description":"The unique identifier of a resource party.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Username":{
            "title":"User Name",
            "type":"string",
            "description":"Name of the user account associated with this resource",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated",
            "type":"string",
            "description":"Who column: indicates the date and time of the last update of the row.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"Who column: indicates the session login associated to the user who last updated the row.",
            "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"
    }
}

ネストされたスキーマ : 画像添付

タイプ: array

タイトル: Picture Attachments

画像添付リソースは、リソースの画像を表示するために使用されます。

ソースを表示

Array of: object resources-PictureAttachment-item-response

{
    "title":"Picture Attachments",
    "type":"array",
    "description":"The picture attachments resource is used to view the picture of a resource.",
    "items":{
        "$ref":"#/components/schemas/resources-PictureAttachment-item-response"
    },
    "x-cardinality":"1"
}

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

タイプ: 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."
        }
    }
}

ネストされたスキーマ : resources-PictureAttachment-item-response

タイプ: object

ソースを表示

AsyncTrackerId: string

タイトル: Asynchronous Upload Tracker Id

アップロードされたファイルのトラッキングに使用される一意の識別子。
AttachedDocumentId: integer (int64)

タイトル: Attached Document Id

添付された画像ドキュメントの一意の識別子。
CategoryName: string

タイトル: Category

最大長: 30

画像添付のカテゴリの名前。
ContentRepositoryFileShared: boolean

タイトル: Shared

添付が共有されているかどうかを示します。デフォルト値はfalseです。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 255

添付画像をアップロードしたユーザー。
CreatedByUserName: string

タイトル: Created By User Name

読取り専用: true

添付画像をアップロードした個人のユーザー名。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

画像の添付ファイルがアップロードされた日付。
DatatypeCode: string

タイトル: Type

最大長: 30

デフォルト値: FILE

画像添付のデータ型。
Description: string

タイトル: Description

最大長: 255

画像添付の説明。
DmDocumentId: string

最大長: 255

添付の作成元となる文書ID。
DmFolderPath: string

タイトル: Dm Folder Path

最大長: 1000

画像の添付ファイルが存在するフォルダ・パス。
DmVersionNumber: string

最大長: 255

添付の作成元となる文書バージョン番号。
DownloadInfo: string

タイトル: DownloadInfo

添付ファイルをプログラムで取得するために使用される情報を含む文字列として表されるJSONオブジェクト。
ErrorStatusCode: string

タイトル: Error Status Code

添付のエラー・コード(ある場合)。
ErrorStatusMessage: string

タイトル: Error Status Message

添付のエラー・メッセージ(ある場合)。
ExpirationDate: string (date-time)

タイトル: Expiration Date

添付ファイルのコンテンツの有効期限。
FileContents: 文字列(バイト)

タイトル: File Contents

添付ファイルの内容。
FileName: string

タイトル: File Name

最大長: 2048

添付ファイルの名前。
FileUrl: string

タイトル: File Url

添付ファイルのURL。
FileWebImage: 文字列(バイト)

タイトル: File Web Image

読取り専用: true

ソースが変換可能なイメージの場合、.png形式で表示されるファイルのbase64エンコード・イメージ。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

レコードが最後に更新された日付。
LastUpdatedBy: string

タイトル: Last Updated By

読取り専用: true

最大長: 255

レコードを最後に更新したユーザー。
LastUpdatedByUserName: string

タイトル: Last Updated By User

読取り専用: true

写真の添付を最後に更新した個人のユーザー名。
links: array Links

タイトル: Links

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

タイトル: Title

添付のタイトル。
UploadedFileContentType: string

タイトル: Uploaded File Content Type

添付のコンテンツ・タイプ。
UploadedFileLength: integer

タイトル: File Size

添付ファイルの長さ。
UploadedFileName: string

タイトル: Uploaded File Name

添付ファイルの名前。
UploadedText: string

タイトル: Uploaded Text

添付にアップロードされたテキスト。
Uri: string

タイトル: Uri

最大長: 4000

添付のURI。
Url: string

タイトル: Url

最大長: 4000

添付のURL。
UserName: string

タイトル: User Name

読取り専用: true

最大長: 255

添付に関連付けられているログイン。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the picture attachment was uploaded.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "Description":{
            "title":"Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the picture attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileName":{
            "title":"File Name",
            "maxLength":2048,
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "FileWebImage":{
            "title":"File Web Image",
            "type":"string",
            "description":"The base64 encoded image of the file displayed in .png format if the source is a convertible image.",
            "format":"byte",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide",
                "PAYLOADHINT":"Show"
            }
        },
        "Uri":{
            "title":"Uri",
            "maxLength":4000,
            "type":"string",
            "description":"The URI of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "Url":{
            "title":"Url",
            "maxLength":4000,
            "type":"string",
            "description":"The URL of the attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "DmDocumentId":{
            "maxLength":255,
            "type":"string",
            "description":"The document ID from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:OA_TRANSLATABLE":"true"
            },
            "x-queryable":true
        },
        "AttachedDocumentId":{
            "title":"Attached Document Id",
            "type":"integer",
            "description":"The unique identifier of the attached picture document.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "includeInCompactView":true,
                "precision":18,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:GLOBALLY_UNIQUE":"true"
            },
            "x-queryable":true
        },
        "UploadedFileContentType":{
            "title":"Uploaded File Content Type",
            "type":"string",
            "description":"The content type of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DownloadInfo":{
            "title":"DownloadInfo",
            "type":"string",
            "description":"JSON object represented as a string containing information used to programmatically retrieve a file attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CreatedByUserName":{
            "title":"Created By User Name",
            "type":"string",
            "description":"The user name of the person who uploaded the picture attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "UploadedFileLength":{
            "title":"File Size",
            "type":"integer",
            "description":"The length of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmVersionNumber":{
            "maxLength":255,
            "type":"string",
            "description":"The document version number from which the attachment is created.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":255,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusMessage":{
            "title":"Error Status Message",
            "type":"string",
            "description":"The error message, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "UserName":{
            "title":"User Name",
            "maxLength":255,
            "type":"string",
            "description":"The login associated with the attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":255,
            "type":"string",
            "description":"The user who uploaded the picture attachment.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "DatatypeCode":{
            "title":"Type",
            "maxLength":30,
            "type":"string",
            "description":"The data type for the picture attachment.",
            "nullable":false,
            "default":"FILE",
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "Title":{
            "title":"Title",
            "type":"string",
            "description":"The title of the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "LastUpdatedByUserName":{
            "title":"Last Updated By User",
            "type":"string",
            "description":"The user name of the person who last updated the picture attachment.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            },
            "x-queryable":true
        },
        "UploadedFileName":{
            "title":"Uploaded File Name",
            "type":"string",
            "description":"The name of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileUrl":{
            "title":"File Url",
            "type":"string",
            "description":"The URL of the attachment file.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "ContentRepositoryFileShared":{
            "title":"Shared",
            "type":"boolean",
            "description":"Indicates if the attachment is shared. The deafult value is false..",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "FileContents":{
            "title":"File Contents",
            "type":"string",
            "description":"The contents of the attachment.",
            "format":"byte",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "XML_ELEMENT":"#hide"
            }
        },
        "ExpirationDate":{
            "title":"Expiration Date",
            "type":"string",
            "description":"The expiration date of the contents in the attachment.",
            "format":"date-time",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true
            },
            "x-queryable":true
        },
        "ErrorStatusCode":{
            "title":"Error Status Code",
            "type":"string",
            "description":"The error code, if any, for the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "DmFolderPath":{
            "title":"Dm Folder Path",
            "maxLength":1000,
            "type":"string",
            "description":"The folder path where the picture attachment exists.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "UploadedText":{
            "title":"Uploaded Text",
            "type":"string",
            "description":"The text uploaded in the attachment.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"false"
            }
        },
        "CategoryName":{
            "title":"Category",
            "maxLength":30,
            "type":"string",
            "description":"The name of the category of the picture attachment.",
            "nullable":true,
            "x-hints":{
                "includeInCompactView":true,
                "fnd:FND_AUDIT_ATTR_ENABLED":"true"
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "includeInCompactView":true,
                "FMT_FORMAT":"d-MMM-yyyy HH:mm:ss"
            },
            "x-queryable":true
        },
        "AsyncTrackerId":{
            "title":"Asynchronous Upload Tracker Id",
            "type":"string",
            "description":"The unique identifier used for tracking the uploaded files.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "DISPLAYHINT":"Hide",
                "includeInCompactView":true,
                "PAYLOADHINT":"Show"
            }
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

Array of: object link

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

リンク

PictureAttachment

操作: /crmRestApi/resources/11.13.18.05/resources/{PartyNumber}/child/PictureAttachment

パラメータ:

PartyNumber: $request.path.PartyNumber

画像添付リソースは、リソースの画像を表示するために使用されます。

SearchFilters

操作: /fscmRestApi/resources/11.13.18.05/standardLookupsLOV

パラメータ:

ファインダ: LookupTypeFinder%3BLookupType%3DORA_HZ_RESOURCE_SEARCH_REC_SET

保存済検索を示す値リスト。

トップに戻る

例:

cURLコマンド

次の例は、cURLを使用してRESTリソースに対する取得リクエストを発行することによってリソースを取得する方法を示しています。 cURLの詳細は、「cURLの使用」を参照してください

curl -u <username:password> \ -X
https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resources/CONTACT-1089

レスポンス本文の例

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

{
  "ResourceProfileId" : 999990000008196,
  "PartyId" : 2490,
  "PartyName" : "Frank Stupor",
  "PartyNumber" : "CONTACT-1089",
  "StartDateActive" : "2008-09-04",
  "EndDateActive" : "4712-12-31",
  "ResourceType" : "INDIVIDUAL",
  "PrimaryOrganization" : "VOL RESOURCE ORG 0",
  "EmailAddress" : "sendmail-test-discard@oracle.com",
  "FormattedAddress" : "7985 Foster City Lane,FOSTER CITY, CA 94404",
  "FormattedPhoneNumber" : "+1 (800) 555-8355",
  "Usage" : "",
  "Manager" : "George Manning",
  "Url" : null,
  "JobMeaning" : null,  
  "PersonFirstName" : "Frank",
  "PersonLastName" : "Stupor",
  "PersonLastNamePrefix" : null,
  "PersonMiddleName" : null,
  "PersonNameSuffix" : null,
  "PersonPreNameAdjunct" : "MR.",
  "PersonPreviousLastName" : null,
  "PersonSecondLastName" : null,
  "links" : [ {
    "rel" : "self",
    "href" : "http://.../crmRestApi/resources/11.1.11/resources/CONTACT-1089",
    "name" : "resources",
    "kind" : "item",
    "properties" : {
      "changeIndicator" : ""
    }
  }, {
    "rel" : "canonical",
    "href" : "http://.../crmRestApi/resources/11.1.11/resources/CONTACT-1089",
    "name" : "resources",
    "kind" : "item"
  } ]
}

ノート:

RecordSetは参照タイプです。 RecordSetを使用してリソースをフィルタできます。レコード・セットは、次の値を使用してリソースRESTおよびリソース・ユーザーRESTでサポートされます:

ORA_MYDIRECTS- 自分の直属の部下: 自分の直属の部下であるリソース。
ORA_MYREPORTEES- すべての直属の部下および間接的部下: 自分の直属の部下または間接的部下であるリソース。
ORA_MYMANAGERANDPEERS- マネージャとピア: 自分のピアまたは自分のマネージャであるリソース。

URLの例

https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceUsers?q=RecordSet='ORA_MYMANAGERANDPEERS'

「トップに戻る」