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

機械翻訳について

リソース・ユーザーの作成

post

/crmRestApi/resources/11.13.18.05/resourceUsers

リクエスト

ヘッダー・パラメータ

Metadata-Context:

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

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

次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

application/json

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

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

タイプ: object

ソースを表示

AddressLine1: string

タイトル: Address Line 1

最大長: 240

リソースのアドレスの最初の行。
AddressLine2: string

タイトル: Address Line 2

最大長: 240

リソースのアドレスの2行目。
BusinessUnit(required): string

タイトル: Business Unit

リソースに関連付けられているビジネス・ユニットの名前。
County: string

タイトル: County

最大長: 60

リソースのアドレスに指定されている郡の名前。
CreateUserAccountFlag: boolean

タイトル: Create User Account

リソースのユーザー・アカウントを作成できるかどうかを示します。デフォルト値はtrueです。
FaxCountryCode: string

タイトル: Phone Country Code

最大長: 10

FAXの国コード。
FirstName(required): string

タイトル: First Name

最大長: 150

リソースの名。
HireDate: 文字列(日付)

タイトル: Hire Date

リソースが採用された日付。
HRManagerEmailAddress: string

タイトル: HR Manager Email

リソースの人事管理マネージャのEメール・アドレス。
IndividualRoleCode: string

タイトル: Individual Role Code

最大長: 255

ユーザーの特別個人ロール。
IndividualRoleEndDate: 文字列(日付)

タイトル: Individual Role End Date

個々のロールが終了する日付。
IndividualRoleStartDate: 文字列(日付)

タイトル: Individual Role Start Date

個々のロールが開始する日付。
JobCode: string

タイトル: Job Code

リソースに割り当てられたジョブ・コード。
LastName(required): string

タイトル: Last Name

最大長: 150

リソースの姓。
LegalEntity(required): string

タイトル: Legal Entity

リソースに関連付けられている法的エンティティの名前。
MiddleName: string

タイトル: Middle Name

最大長: 60

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

タイトル: Phone Country Code

最大長: 10

携帯電話に関連付けられている国コード。
PersonType(required): string

タイトル: Person Type

リソースに関連付けられている就業者の雇用関係のタイプ。退職者、従業員、派遣または就業者。
Province: string

タイトル: Province

最大長: 60

リソースのアドレスに指定された州の名前。
RawFaxNumber: string

タイトル: Fax

最大長: 60

RAW形式のリソースのFAX番号。
RawMobilePhoneNumber: string

タイトル: Mobile Phone

最大長: 60

リソースの携帯電話番号。
RawWorkPhoneNumber: string

タイトル: Work Phone

最大長: 60

未処理書式のリソース勤務先電話番号。
ResourceEmail(required): string

タイトル: Email

最大長: 320

リソースの電子メール・アドレス。
ResourceEndDate(required): 文字列(日付)

タイトル: To Date

リソースがアクティブになるまでの日付。
ResourceManagerFirstName: string

タイトル: Manager First Name

最大長: 255

リソースのレポート・マネージャの名。
ResourceManagerLastName: string

タイトル: Manager Last Name

最大長: 255

リソースのレポート・マネージャの姓。
ResourceManagerName: string

タイトル: Manager Name

最大長: 255

リソースのマネージャの名前。
ResourceOrganizationName: string

タイトル: Organization

最大長: 255

管理ロールのリソースに関連付けられているリソース組織の名前。
ResourceOrgManagerEmail: string

タイトル: Manager Email

最大長: 255

リソースのレポート・マネージャのEメール・アドレス。
ResourceOrgMemRoleEndDate: 文字列(日付)

タイトル: Membership Role End Date

リソースのメンバーシップが終了する日付。
ResourceOrgMemRoleStartDate: 文字列(日付)

タイトル: Organization Membership Role Start Date

リソースが組織のメンバーになる日付。
ResourceOrgRoleCode: string

タイトル: Organization Role Code

最大長: 255

組織メンバーシップに関連するリソースのロールを示すコード。たとえば、SALES_REPRESENTATIVEまたはSALES_MANAGERです。
ResourceParentOrganizationName: string

タイトル: Parent Organization

最大長: 255

リソースのマネージャが関連付けられている組織の名前。
ResourcePartyId: integer (int64)

タイトル: Party ID

リソースに関連付けられたパーティの一意の識別子。
ResourcePartyNumber: string

タイトル: Party Number

最大長: 30

リソースに関連付けられたパーティの一意の識別子。
ResourceRoleAssign: array Resource Role Assignments

タイトル: Resource Role Assignments

リソース・ロール割当リソースは、リソースに割り当てられたロール(実装者、再販業者など)を表示するために使用されます。
ResourceStartDate: 文字列(日付)

タイトル: Resource Start Date

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

タイトル: Usage

リソースのタイプ。
State: string

タイトル: State

最大長: 60

リソースのアドレスに指定された状態の名前。
TimezoneCode: string

タイトル: Time Zone Code

最大長: 64

リソースのタイム・ゾーンのコード。
Title: string

タイトル: Title

最大長: 60

リソース名の前のタイトル。
TopResourceFlag: boolean

タイトル: Root Resource

デフォルト値: false

リソースが階層の最上位ユーザーかどうかを示します。
UserStatus: string

タイトル: User Account Status

最大長: 255

リソースのユーザー・アカウントのステータスを示します。サポートされる値は、アクティブの場合はA、一時停止の場合はSです。新規アカウントのステータスはAに設定されます。
WorkPhoneCountryCode: string

タイトル: Phone Country Code

最大長: 10

勤務先電話番号に関連付けられた国コード。

{
    "required":[
        "BusinessUnit",
        "FirstName",
        "LastName",
        "LegalEntity",
        "PersonType",
        "ResourceEmail",
        "ResourceEndDate"
    ],
    "type":"object",
    "properties":{
        "LegalEntity":{
            "title":"Legal Entity",
            "type":"string",
            "description":"The name of the legal entity of associated with the resource.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "TimezoneCode":{
            "title":"Time Zone Code",
            "maxLength":64,
            "type":"string",
            "description":"The code for the time zone of the resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "AttributeType":"Picklist"
            }
        },
        "ResourceOrgRoleCode":{
            "title":"Organization Role Code",
            "maxLength":255,
            "type":"string",
            "description":"The code indicating the role of the resource in association with organization membership. For example, SALES_REPRESENTATIVE or SALES_MANAGER.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RawMobilePhoneNumber":{
            "title":"Mobile Phone",
            "maxLength":60,
            "type":"string",
            "description":"The mobile phone number of the resource.",
            "nullable":true,
            "x-queryable":false
        },
        "IndividualRoleCode":{
            "title":"Individual Role Code",
            "maxLength":255,
            "type":"string",
            "description":"The special individual role of the user.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "FaxCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code of the fax.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceManagerFirstName":{
            "title":"Manager First Name",
            "maxLength":255,
            "type":"string",
            "description":"The first name of the reporting manager of the resource.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MgrStr"
                ]
            }
        },
        "PersonType":{
            "title":"Person Type",
            "type":"string",
            "description":"The type of the work relationship of a worker associated with the resource. For exampe, Employee, Contingent, or Worker.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceEndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date up to which the resource is active.",
            "format":"date",
            "nullable":false
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The name of the county provided in the resource's address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            }
        },
        "UserStatus":{
            "title":"User Account Status",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the the status of the user account for the resource. The supported values are A for active and S for suspended. The status is set to A for new accounts.",
            "nullable":true
        },
        "ResourceManagerLastName":{
            "title":"Manager Last Name",
            "maxLength":255,
            "type":"string",
            "description":"The last name of the reporting manager of the resource.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MgrStr"
                ]
            }
        },
        "IndividualRoleEndDate":{
            "title":"Individual Role End Date",
            "type":"string",
            "description":"The date when the individual role ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "RawWorkPhoneNumber":{
            "title":"Work Phone",
            "maxLength":60,
            "type":"string",
            "description":"The resource's work phone number in raw format.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceOrganizationName":{
            "title":"Organization",
            "maxLength":255,
            "type":"string",
            "description":"The name of the resource organization associated to the resource in managerial role.",
            "nullable":true
        },
        "JobCode":{
            "title":"Job Code",
            "type":"string",
            "description":"The job code assigned to the resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourcePartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the party associated with the resource.",
            "nullable":true
        },
        "CreateUserAccountFlag":{
            "title":"Create User Account",
            "type":"boolean",
            "description":"Indicates whether a user account can be created for the resource. The default value is true.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "HireDate":{
            "title":"Hire Date",
            "type":"string",
            "description":"The date when the resource was hired.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "WorkPhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code associated with the work phone.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceRoleAssign":{
            "title":"Resource Role Assignments",
            "type":"array",
            "description":"The resource role assignments resource is used to view the role assigned to a resource, such as implementer, reseller, and so on.",
            "items":{
                "$ref":"#/components/schemas/resourceUsers-ResourceRoleAssign-item-post-request"
            }
        },
        "ResourceEmail":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the resource.",
            "nullable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            }
        },
        "ResourceOrgMemRoleEndDate":{
            "title":"Membership Role End Date",
            "type":"string",
            "description":"The date when the membership of the resource ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "MobilePhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code associated with the mobile phone.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "HRManagerEmailAddress":{
            "title":"HR Manager Email",
            "type":"string",
            "description":"The email address of the human resource manager of the resource.",
            "nullable":true,
            "x-queryable":false
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the resource.",
            "nullable":false,
            "x-queryable":false
        },
        "ResourceParentOrganizationName":{
            "title":"Parent Organization",
            "maxLength":255,
            "type":"string",
            "description":"The name of the organization to which the manager of the resource is associated.",
            "nullable":true
        },
        "Title":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title preceding the name of the resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "IndividualRoleStartDate":{
            "title":"Individual Role Start Date",
            "type":"string",
            "description":"The date when the individual role starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceType":{
            "title":"Usage",
            "type":"string",
            "description":"The type of the resource.",
            "nullable":true,
            "x-queryable":false
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the resource.",
            "nullable":true,
            "x-queryable":false
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The name of the province provided in the resource's address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "ResourceOrgManagerEmail":{
            "title":"Manager Email",
            "maxLength":255,
            "type":"string",
            "description":"The email address of the reporting manager of the resource.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MgrStr"
                ]
            }
        },
        "ResourceManagerName":{
            "title":"Manager Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the manager of the resource.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MgrStr"
                ]
            }
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address of the resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address of the resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "type":"string",
            "description":"The name of the business unit associated with the resource.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The name of the state provided in the resource's address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            }
        },
        "TopResourceFlag":{
            "title":"Root Resource",
            "type":"boolean",
            "description":"Indicates whether the resource is top user in hierarchy.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RawFaxNumber":{
            "title":"Fax",
            "maxLength":60,
            "type":"string",
            "description":"The fax number of the resource in raw format.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourcePartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party associated with the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the resource.",
            "nullable":false
        },
        "ResourceStartDate":{
            "title":"Resource Start Date",
            "type":"string",
            "description":"The date when the resource becomes active.",
            "format":"date",
            "nullable":false
        },
        "ResourceOrgMemRoleStartDate":{
            "title":"Organization Membership Role Start Date",
            "type":"string",
            "description":"The date when the resource becomes a member of the organization.",
            "format":"date",
            "nullable":true
        }
    }
}

ネストされたスキーマ : リソース・ロール割当

タイプ: array

タイトル: Resource Role Assignments

リソース・ロール割当リソースは、リソースに割り当てられたロール(実装者、再販業者など)を表示するために使用されます。

ソースを表示

Array of: object resourceUsers-ResourceRoleAssign-item-post-request

{
    "title":"Resource Role Assignments",
    "type":"array",
    "description":"The resource role assignments resource is used to view the role assigned to a resource, such as implementer, reseller, and so on.",
    "items":{
        "$ref":"#/components/schemas/resourceUsers-ResourceRoleAssign-item-post-request"
    }
}

ネストされたスキーマ : resourceUsers-ResourceRoleAssign-item-post-request

タイプ: object

ソースを表示

EndDateActive: 文字列(日付)

タイトル: To Date

リソース・ロールが非アクティブになる日付。
PartyName: string

タイトル: Resource

最大長: 360

パーティの名前。
RoleId: integer

タイトル: Role

ロールの一意の識別子。
RoleResourceId: integer

リソース・ロールの一意の識別子。
StartDateActive: 文字列(日付)

タイトル: From Date

リソース・ロールがアクティブになる日付。

{
    "type":"object",
    "properties":{
        "StartDateActive":{
            "title":"From Date",
            "type":"string",
            "description":"The date when the resource role become active.",
            "format":"date",
            "nullable":false
        },
        "PartyName":{
            "title":"Resource",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            }
        },
        "EndDateActive":{
            "title":"To Date",
            "type":"string",
            "description":"The date when the resource role becomes inactive.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DefaultValue":"FUTURE_DATE"
            }
        },
        "RoleResourceId":{
            "type":"integer",
            "description":"The unique identifier of the resource role.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate"
            }
        },
        "RoleId":{
            "title":"Role",
            "type":"integer",
            "description":"The unique identifier of the role.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "fnd:FND_AUDIT_USER_KEY":"true",
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.cdm.foundation.resources.publicModel.view.ResourceRoleVVO",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"RoleName",
                "fnd:FND_AUDIT_FK_WHEREATTR":"RoleId"
            }
        }
    }
}

トップに戻る

応答

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

application/json

デフォルトのレスポンス

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

ヘッダー

Metadata-Context(required):

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

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

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

タイプ: object

ソースを表示

AddressLine1: string

タイトル: Address Line 1

最大長: 240

リソースのアドレスの最初の行。
AddressLine2: string

タイトル: Address Line 2

最大長: 240

リソースのアドレスの2行目。
BusinessUnit: string

タイトル: Business Unit

リソースに関連付けられているビジネス・ユニットの名前。
City: string

タイトル: City

読取り専用: true

最大長: 60

リソースの住所に指定された市区町村の名前。
Country: string

タイトル: Country

読取り専用: true

最大長: 2

リソースの住所に指定された国名。
County: string

タイトル: County

最大長: 60

リソースのアドレスに指定されている郡の名前。
CreatedBy: string

タイトル: Created By

読取り専用: true

最大長: 64

レコードを作成したユーザー。
CreateUserAccountFlag: boolean

タイトル: Create User Account

リソースのユーザー・アカウントを作成できるかどうかを示します。デフォルト値はtrueです。
CreationDate: string (date-time)

タイトル: Creation Date

読取り専用: true

レコードが作成された日時。
DeleteFlag: boolean

読取り専用: true

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

タイトル: Phone Country Code

最大長: 10

FAXの国コード。
FirstName: string

タイトル: First Name

最大長: 150

リソースの名。
FormattedAddress: string

読取り専用: true

最大長: 255

リソースのプライマリ形式のアドレス。
HireDate: 文字列(日付)

タイトル: Hire Date

リソースが採用された日付。
HRManagerEmailAddress: string

タイトル: HR Manager Email

リソースの人事管理マネージャのEメール・アドレス。
IndividualRoleCode: string

タイトル: Individual Role Code

最大長: 255

ユーザーの特別個人ロール。
IndividualRoleEndDate: 文字列(日付)

タイトル: Individual Role End Date

個々のロールが終了する日付。
IndividualRoleStartDate: 文字列(日付)

タイトル: Individual Role Start Date

個々のロールが開始する日付。
JobCode: string

タイトル: Job Code

リソースに割り当てられたジョブ・コード。
JobTitle: string

タイトル: Job Title

読取り専用: true

リソースに割り当てられたジョブのタイトル。
LastName: string

タイトル: Last Name

最大長: 150

リソースの姓。
LastUpdateDate: string (date-time)

タイトル: Last Update Date

読取り専用: true

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

タイトル: Last Updated By

読取り専用: true

最大長: 64

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

タイトル: Legal Entity

リソースに関連付けられている法的エンティティの名前。
links: array Links

タイトル: Links

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

タイトル: Middle Name

最大長: 60

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

タイトル: Phone Country Code

最大長: 10

携帯電話に関連付けられている国コード。
PartyName: string

タイトル: Resource Name

読取り専用: true

最大長: 360

個人の名前。
PersonNumber: string

タイトル: Person Number

読取り専用: true

リソースの就業者レコードの個人番号識別子。
PersonType: string

タイトル: Person Type

リソースに関連付けられている就業者の雇用関係のタイプ。退職者、従業員、派遣または就業者。
PostalCode: string

タイトル: Postal Code

読取り専用: true

最大長: 60

リソースの住所の郵便番号。
Province: string

タイトル: Province

最大長: 60

リソースのアドレスに指定された州の名前。
RawFaxNumber: string

タイトル: Fax

最大長: 60

RAW形式のリソースのFAX番号。
RawMobilePhoneNumber: string

タイトル: Mobile Phone

最大長: 60

リソースの携帯電話番号。
RawWorkPhoneNumber: string

タイトル: Work Phone

最大長: 60

未処理書式のリソース勤務先電話番号。
ResourceEmail: string

タイトル: Email

最大長: 320

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

タイトル: To Date

リソースがアクティブになるまでの日付。
ResourceManagerFirstName: string

タイトル: Manager First Name

最大長: 255

リソースのレポート・マネージャの名。
ResourceManagerLastName: string

タイトル: Manager Last Name

最大長: 255

リソースのレポート・マネージャの姓。
ResourceManagerName: string

タイトル: Manager Name

最大長: 255

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

タイトル: Manager Party ID

読取り専用: true

リソースのレポート・マネージャの一意の識別子。
ResourceManagerPartyNumber: string

タイトル: Manager Party Number

読取り専用: true

最大長: 255

リソースのレポート・マネージャの一意の公開識別子。
ResourceOrganizationName: string

タイトル: Organization

最大長: 255

管理ロールのリソースに関連付けられているリソース組織の名前。
ResourceOrganizationUsage: string

タイトル: Organization Usage

読取り専用: true

最大長: 255

リソース組織の使用タイプ。たとえば、営業やマーケティングなどです。
ResourceOrgManagerEmail: string

タイトル: Manager Email

最大長: 255

リソースのレポート・マネージャのEメール・アドレス。
ResourceOrgMemRoleEndDate: 文字列(日付)

タイトル: Membership Role End Date

リソースのメンバーシップが終了する日付。
ResourceOrgMemRoleStartDate: 文字列(日付)

タイトル: Organization Membership Role Start Date

リソースが組織のメンバーになる日付。
ResourceOrgRoleCode: string

タイトル: Organization Role Code

最大長: 255

組織メンバーシップに関連するリソースのロールを示すコード。たとえば、SALES_REPRESENTATIVEまたはSALES_MANAGERです。
ResourceOrgRoleName: string

読取り専用: true

最大長: 255

組織または階層内のリソースの機能を定義するロール。
ResourceParentOrganizationName: string

タイトル: Parent Organization

最大長: 255

リソースのマネージャが関連付けられている組織の名前。
ResourcePartyId: integer (int64)

タイトル: Party ID

リソースに関連付けられたパーティの一意の識別子。
ResourcePartyNumber: string

タイトル: Party Number

最大長: 30

リソースに関連付けられたパーティの一意の識別子。
ResourceProfileId: integer (int64)

タイトル: Profile ID

読取り専用: true

リソースのプロファイルの一意の識別子。
ResourceRoleAssign: array Resource Role Assignments

タイトル: Resource Role Assignments

リソース・ロール割当リソースは、リソースに割り当てられたロール(実装者、再販業者など)を表示するために使用されます。
ResourceStartDate: 文字列(日付)

タイトル: Resource Start Date

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

タイトル: Usage

リソースのタイプ。
State: string

タイトル: State

最大長: 60

リソースのアドレスに指定された状態の名前。
TimezoneCode: string

タイトル: Time Zone Code

最大長: 64

リソースのタイム・ゾーンのコード。
Title: string

タイトル: Title

最大長: 60

リソース名の前のタイトル。
TopResourceFlag: boolean

タイトル: Root Resource

デフォルト値: false

リソースが階層の最上位ユーザーかどうかを示します。
UpdateFlag: boolean

タイトル: Update Access

読取り専用: true

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

タイトル: User Name

読取り専用: true

リソース・ユーザーのログインに使用されるユーザー名またはアカウント名。
UserStatus: string

タイトル: User Account Status

最大長: 255

リソースのユーザー・アカウントのステータスを示します。サポートされる値は、アクティブの場合はA、一時停止の場合はSです。新規アカウントのステータスはAに設定されます。
WorkPhoneCountryCode: string

タイトル: Phone Country Code

最大長: 10

勤務先電話番号に関連付けられた国コード。

{
    "type":"object",
    "properties":{
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the record was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LegalEntity":{
            "title":"Legal Entity",
            "type":"string",
            "description":"The name of the legal entity of associated with the resource.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "RawMobilePhoneNumber":{
            "title":"Mobile Phone",
            "maxLength":60,
            "type":"string",
            "description":"The mobile phone number of the resource.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceProfileId":{
            "title":"Profile ID",
            "type":"integer",
            "description":"The unique identifier of the profile of the resource.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "FaxCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code of the fax.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Resource Name",
            "maxLength":360,
            "type":"string",
            "description":"The name of the person.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceManagerFirstName":{
            "title":"Manager First Name",
            "maxLength":255,
            "type":"string",
            "description":"The first name of the reporting manager of the resource.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MgrStr"
                ]
            },
            "x-queryable":true
        },
        "PersonType":{
            "title":"Person Type",
            "type":"string",
            "description":"The type of the work relationship of a worker associated with the resource. For exampe, Employee, Contingent, or Worker.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "ResourceEndDate":{
            "title":"To Date",
            "type":"string",
            "description":"The date up to which the resource is active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "UserStatus":{
            "title":"User Account Status",
            "maxLength":255,
            "type":"string",
            "description":"Indicates the the status of the user account for the resource. The supported values are A for active and S for suspended. The status is set to A for new accounts.",
            "nullable":true,
            "x-queryable":true
        },
        "ResourceManagerLastName":{
            "title":"Manager Last Name",
            "maxLength":255,
            "type":"string",
            "description":"The last name of the reporting manager of the resource.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MgrStr"
                ]
            },
            "x-queryable":true
        },
        "ResourcePartyNumber":{
            "title":"Party Number",
            "maxLength":30,
            "type":"string",
            "description":"The unique identifier of the party associated with the resource.",
            "nullable":true,
            "x-queryable":true
        },
        "HireDate":{
            "title":"Hire Date",
            "type":"string",
            "description":"The date when the resource was hired.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ResourceOrganizationUsage":{
            "title":"Organization Usage",
            "maxLength":255,
            "type":"string",
            "description":"The usage type of the resource organization. For example, Sales or Marketing.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceEmail":{
            "title":"Email",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the resource.",
            "nullable":false,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "ResourceOrgMemRoleEndDate":{
            "title":"Membership Role End Date",
            "type":"string",
            "description":"The date when the membership of the resource ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MobilePhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code associated with the mobile phone.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "HRManagerEmailAddress":{
            "title":"HR Manager Email",
            "type":"string",
            "description":"The email address of the human resource manager of the resource.",
            "nullable":true,
            "x-queryable":false
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceParentOrganizationName":{
            "title":"Parent Organization",
            "maxLength":255,
            "type":"string",
            "description":"The name of the organization to which the manager of the resource is associated.",
            "nullable":true,
            "x-queryable":true
        },
        "FormattedAddress":{
            "maxLength":255,
            "type":"string",
            "description":"The primary formatted address of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "City":{
            "title":"City",
            "maxLength":60,
            "type":"string",
            "description":"The name of the city provided in the resource's address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.City",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"City"
            }
        },
        "DeleteFlag":{
            "type":"boolean",
            "description":"Indicates if the user can delete the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Province":{
            "title":"Province",
            "maxLength":60,
            "type":"string",
            "description":"The name of the province provided in the resource's address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Province",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Province"
            }
        },
        "ResourceManagerPartyId":{
            "title":"Manager Party ID",
            "type":"integer",
            "description":"The unique identifier of the reporting manager of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "MgrStr"
                ]
            }
        },
        "ResourceOrgManagerEmail":{
            "title":"Manager Email",
            "maxLength":255,
            "type":"string",
            "description":"The email address of the reporting manager of the resource.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MgrStr"
                ]
            },
            "x-queryable":true
        },
        "AddressLine2":{
            "title":"Address Line 2",
            "maxLength":240,
            "type":"string",
            "description":"The second line of the address of the resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address2",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 2",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "AddressLine1":{
            "title":"Address Line 1",
            "maxLength":240,
            "type":"string",
            "description":"The first line of the address of the resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.Address1",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Address Line 1",
                "protectionTokenizationScheme":"WORD"
            }
        },
        "BusinessUnit":{
            "title":"Business Unit",
            "type":"string",
            "description":"The name of the business unit associated with the resource.",
            "nullable":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "State":{
            "title":"State",
            "maxLength":60,
            "type":"string",
            "description":"The name of the state provided in the resource's address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.State",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"State"
            }
        },
        "TopResourceFlag":{
            "title":"Root Resource",
            "type":"boolean",
            "description":"Indicates whether the resource is top user in hierarchy.",
            "nullable":true,
            "default":false,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "Country":{
            "title":"Country",
            "maxLength":2,
            "type":"string",
            "description":"The name of the country provided in the resource's address.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ResourcePartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the party associated with the resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastName":{
            "title":"Last Name",
            "maxLength":150,
            "type":"string",
            "description":"The last name of the resource.",
            "nullable":false,
            "x-queryable":true
        },
        "ResourceStartDate":{
            "title":"Resource Start Date",
            "type":"string",
            "description":"The date when the resource becomes active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "TimezoneCode":{
            "title":"Time Zone Code",
            "maxLength":64,
            "type":"string",
            "description":"The code for the time zone of the resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "AttributeType":"Picklist"
            }
        },
        "ResourceOrgRoleCode":{
            "title":"Organization Role Code",
            "maxLength":255,
            "type":"string",
            "description":"The code indicating the role of the resource in association with organization membership. For example, SALES_REPRESENTATIVE or SALES_MANAGER.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "IndividualRoleCode":{
            "title":"Individual Role Code",
            "maxLength":255,
            "type":"string",
            "description":"The special individual role of the user.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PostalCode":{
            "title":"Postal Code",
            "maxLength":60,
            "type":"string",
            "description":"The postal code for the address of resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.PostalCode",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Postal Code"
            }
        },
        "JobTitle":{
            "title":"Job Title",
            "type":"string",
            "description":"The title of the job assigned to the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "County":{
            "title":"County",
            "maxLength":60,
            "type":"string",
            "description":"The name of the county provided in the resource's address.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "protectionKey":"PartySiteEO.County",
                "protectionObjectTitle":"Address",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"County"
            }
        },
        "UpdateFlag":{
            "title":"Update Access",
            "type":"boolean",
            "description":"Indicates if the user can update the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "IndividualRoleEndDate":{
            "title":"Individual Role End Date",
            "type":"string",
            "description":"The date when the individual role ends.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "RawWorkPhoneNumber":{
            "title":"Work Phone",
            "maxLength":60,
            "type":"string",
            "description":"The resource's work phone number in raw format.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceOrganizationName":{
            "title":"Organization",
            "maxLength":255,
            "type":"string",
            "description":"The name of the resource organization associated to the resource in managerial role.",
            "nullable":true,
            "x-queryable":true
        },
        "JobCode":{
            "title":"Job Code",
            "type":"string",
            "description":"The job code assigned to the resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "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
        },
        "CreateUserAccountFlag":{
            "title":"Create User Account",
            "type":"boolean",
            "description":"Indicates whether a user account can be created for the resource. The default value is true.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "WorkPhoneCountryCode":{
            "title":"Phone Country Code",
            "maxLength":10,
            "type":"string",
            "description":"The country code associated with the work phone.",
            "nullable":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "ResourceRoleAssign":{
            "title":"Resource Role Assignments",
            "type":"array",
            "description":"The resource role assignments resource is used to view the role assigned to a resource, such as implementer, reseller, and so on.",
            "items":{
                "$ref":"#/components/schemas/resourceUsers-ResourceRoleAssign-item-response"
            }
        },
        "PersonNumber":{
            "title":"Person Number",
            "type":"string",
            "description":"The person number identifier of the worker record of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "FirstName":{
            "title":"First Name",
            "maxLength":150,
            "type":"string",
            "description":"The first name of the resource.",
            "nullable":false,
            "x-queryable":false
        },
        "Title":{
            "title":"Title",
            "maxLength":60,
            "type":"string",
            "description":"The title preceding the name of the resource.",
            "nullable":true,
            "x-queryable":false,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "IndividualRoleStartDate":{
            "title":"Individual Role Start Date",
            "type":"string",
            "description":"The date when the individual role starts.",
            "format":"date",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceType":{
            "title":"Usage",
            "type":"string",
            "description":"The type of the resource.",
            "nullable":true,
            "x-queryable":false
        },
        "MiddleName":{
            "title":"Middle Name",
            "maxLength":60,
            "type":"string",
            "description":"The middle name of the resource.",
            "nullable":true,
            "x-queryable":false
        },
        "ResourceManagerPartyNumber":{
            "title":"Manager Party Number",
            "maxLength":255,
            "type":"string",
            "description":"The unique public identifier of the reporting manager of the resource.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false,
            "x-hints":{
                "dependencies":[
                    "MgrStr"
                ]
            }
        },
        "ResourceManagerName":{
            "title":"Manager Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the manager of the resource.",
            "nullable":true,
            "x-hints":{
                "dependencies":[
                    "MgrStr"
                ]
            },
            "x-queryable":true
        },
        "Username":{
            "title":"User Name",
            "type":"string",
            "description":"The user name or account name, used for login, of the resource user.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "<",
                    "<=",
                    ">",
                    ">=",
                    "BETWEEN",
                    "NOTBETWEEN",
                    "CONTAINS",
                    "DOESNOTCONTAIN"
                ]
            },
            "x-queryable":true
        },
        "RawFaxNumber":{
            "title":"Fax",
            "maxLength":60,
            "type":"string",
            "description":"The fax number of the resource in raw format.",
            "nullable":true,
            "x-queryable":false
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ResourceOrgMemRoleStartDate":{
            "title":"Organization Membership Role Start Date",
            "type":"string",
            "description":"The date when the resource becomes a member of the organization.",
            "format":"date",
            "nullable":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

タイトル: Resource Role Assignments

リソース・ロール割当リソースは、リソースに割り当てられたロール(実装者、再販業者など)を表示するために使用されます。

ソースを表示

Array of: object resourceUsers-ResourceRoleAssign-item-response

{
    "title":"Resource Role Assignments",
    "type":"array",
    "description":"The resource role assignments resource is used to view the role assigned to a resource, such as implementer, reseller, and so on.",
    "items":{
        "$ref":"#/components/schemas/resourceUsers-ResourceRoleAssign-item-response"
    }
}

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

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

ネストされたスキーマ : resourceUsers-ResourceRoleAssign-item-response

タイプ: object

ソースを表示

EndDateActive: 文字列(日付)

タイトル: To Date

リソース・ロールが非アクティブになる日付。
links: array Links

タイトル: Links

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

タイトル: Resource

最大長: 360

パーティの名前。
RoleCode: string

読取り専用: true

最大長: 30

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

タイトル: Role

ロールの一意の識別子。
RoleRelateId: integer

読取り専用: true

ロール関係識別子(PK)
RoleResourceId: integer

リソース・ロールの一意の識別子。
StartDateActive: 文字列(日付)

タイトル: From Date

リソース・ロールがアクティブになる日付。

{
    "type":"object",
    "properties":{
        "RoleRelateId":{
            "type":"integer",
            "description":"Role Relation identifier (PK)",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "fnd:GLOBALLY_UNIQUE":"true",
                "PAYLOADHINT":"Show"
            },
            "x-queryable":true
        },
        "StartDateActive":{
            "title":"From Date",
            "type":"string",
            "description":"The date when the resource role become active.",
            "format":"date",
            "nullable":false,
            "x-queryable":true
        },
        "EndDateActive":{
            "title":"To Date",
            "type":"string",
            "description":"The date when the resource role becomes inactive.",
            "format":"date",
            "nullable":false,
            "x-hints":{
                "DefaultValue":"FUTURE_DATE"
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "PartyName":{
            "title":"Resource",
            "maxLength":360,
            "type":"string",
            "description":"The name of the party.",
            "nullable":false,
            "x-hints":{
                "controlType":"combo_lov"
            },
            "x-queryable":true
        },
        "RoleResourceId":{
            "type":"integer",
            "description":"The unique identifier of the resource role.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate"
            },
            "x-queryable":true
        },
        "RoleCode":{
            "maxLength":30,
            "type":"string",
            "description":"The value of the code for the role assigned to the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RoleId":{
            "title":"Role",
            "type":"integer",
            "description":"The unique identifier of the role.",
            "nullable":false,
            "x-hints":{
                "fnd:FND_AUDIT_FORCE_WRITE":"true",
                "fnd:FND_AUDIT_USER_KEY":"true",
                "controlType":"choice",
                "fnd:FND_AUDIT_FK_VIEWOBJECT":"oracle.apps.cdm.foundation.resources.publicModel.view.ResourceRoleVVO",
                "ATTR_INTERNAL_USE":"Y",
                "ExtnEventActionProperty":"HideInCreateTask;HideInEmailTemplate;HideInFieldUpdate",
                "fnd:FND_AUDIT_ATTR_ENABLED":"true",
                "fnd:FND_AUDIT_FK_DISPLAYATTR":"RoleName",
                "fnd:FND_AUDIT_FK_WHEREATTR":"RoleId"
            },
            "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"
    }
}

リンク

FaxCountryCodeVA

操作: /crmRestApi/resources/11.13.18.05/countryCodes

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: FaxCountryCode;ターゲット属性: PhoneCountryCode
表示属性: PhoneCountryCode, TerritoryShortName

MobilePhoneCountryCodeVA

操作: /crmRestApi/resources/11.13.18.05/countryCodes

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: MobilePhoneCountryCode;ターゲット属性: PhoneCountryCode
表示属性: PhoneCountryCode, TerritoryShortName

ResourceRoleAssign

操作: /crmRestApi/resources/11.13.18.05/resourceUsers/{resourceUsersUniqID}/child/ResourceRoleAssign

パラメータ:

resourceUsersUniqID: $request.path.resourceUsersUniqID

リソース・ロール割当リソースは、リソースに割り当てられたロール(実装者、再販業者など)を表示するために使用されます。

WorkPhoneCountryCodeVA

操作: /crmRestApi/resources/11.13.18.05/countryCodes

LOVリンク関連では、次のプロパティが定義されます:

ソース属性: WorkPhoneCountryCode;ターゲット属性: PhoneCountryCode
表示属性: PhoneCountryCode, TerritoryShortName

トップに戻る

例:

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行して、リソース・ユーザーを作成する方法を示しています。

ノート:

開始日が指定されていないリソースにロールを追加すると、開始日はリソースの採用日に設定されます。

cURLコマンド

curl --user sales_cloud_user -X PATCH -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceUsers/

リクエスト本文の例

次の例は、JSON形式のリクエスト本文のコンテンツを示しています。

{
    "LegalEntity": "Vision Corporation",
    "BusinessUnit": "Vision Corporation Enterprise",
    "FirstName": "ABC",
    "LastName": "20200717_1706",
    "Title":"MR.",
    "ResourceEmail": "ABC_20200717_1706@oracle.com",
    "PersonType": "EMP",
    "HireDate": "2007-05-01",
    "ResourceStartDate": "2007-05-01",
    "Username": "ABC_20200717_1706@oracle.com",
    "IndividualRoleCode": "SALES_MANAGER"
}

レスポンス本文の例

次に、JSON形式のレスポンス本文の内容を示します。

{
  "ResourceProfileId": 300100185303175,
  "PartyName": "ABC 20200717_1706",
  "LastUpdateDate": "2020-07-20T07:31:31.019+00:00",
  "LastUpdatedBy": "sales_admin",
  "CreationDate": "2020-07-20T07:31:27.001+00:00",
  "CreatedBy": "sales_admin",
  "ResourceType": null,
  "FormattedAddress": null,
  "TimezoneCode": null,
  "Username": "ABC_20200717_1706@oracle.com",
  "City": null,
  "Country": null,
  "PostalCode": null,
  "UpdateFlag": "true",
  "DeleteFlag": "false",
  "ResourceOrgRoleCode": null,
  "ResourceOrgRoleName": null,
  "FirstName": "ABC",
  "LastName": "20200717_1706",
  "MiddleName": null,
  "Title": "MR.",
  "ResourcePartyNumber": "CDRM_885912",
  "State": null,
  "ResourceEmail": "ABC_20200717_1706@oracle.com",
  "WorkPhoneCountryCode": null,
  "RawWorkPhoneNumber": null,
  "MobilePhoneCountryCode": null,
  "RawMobilePhoneNumber": null,
  "FaxCountryCode": null,
  "RawFaxNumber": null,
  "AddressLine1": null,
  "AddressLine2": null,
  "ResourceStartDate": "2007-05-01",
  "ResourceEndDate": "4712-12-31",
  "ResourcePartyId": 300100185303176,
  "ResourceOrganizationName": null,
  "ResourceOrganizationUsage": null,
  "ResourceOrgMemRoleEndDate": null,
  "ResourceParentOrganizationName": null,
  "ResourceOrgManagerEmail": null,
  "ResourceManagerName": null,
  "ResourceManagerFirstName": null,
  "ResourceManagerLastName": null,
  "HRManagerEmailAddress": null,
  "HireDate": "2007-05-01",
  "ResourceOrgMemRoleStartDate": null,
  "IndividualRoleCode": "SALES_MANAGER",
  "IndividualRoleStartDate": null,
  "IndividualRoleEndDate": null,
  "ResourceManagerPartyNumber": null,
  "County": null,
  "Province": null,
  "ResourceManagerPartyId": null,
  "TopResourceFlag": false,
  "PersonNumber": null,
  "BusinessUnit": "Vision Corporation Enterprise",
  "LegalEntity": "Vision Corporation",
  "JobCode": null,
  "JobTitle": null,
  "UserStatus": null,
  "PersonType": "EMP",
  "CreateUserAccountFlag": true,
  "__ORACO__DistributionCentre_Id_c": null,
  "__ORACO__DistributionCentre_c": null,
  "__ORACO__Segment_c": null,
  "links": [
    {
      "rel": "self",
      "href": "https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.18.05/resourceUsers/CDRM_885912",
      "name": "resourceUsers",
      "kind": "item",
      "properties": {
        "changeIndicator": "ACED0005737200136A6176612E7574696C2E41727261794C6973747881D21D99C7619D03000149000473697A65787000000009770400000009737200116A6176612E6C616E672E496E746567657212E2A0A4F781873802000149000576616C7565787200106A6176612E6C616E672E4E756D62657286AC951D0B94E08B0200007870000000017371007E0002000000017371007E0002000000027372001B6F7261636C652E6A626F2E646F6D61696E2E4E756C6C56616C75655899C1C58DAABEEB02000149000A6D53514C54797065496478700000000C71007E000871007E00087371007E00020000000171007E000871007E000878"
      }
    },...
}

ノート:

新しいリソース・ユーザーを作成すると、CreateUserAccountFlagによってリソースのユーザー・アカウントの作成が制御されます。 CreateUserAccountFlagのデフォルト値はYです。フラグがNに設定されている場合、ロール・プロビジョニングは抑制されます。

ノート:

UserStatusのデフォルト値はAです。ポスト・ペイロードに含めないでください。ユーザーを一時停止するには、PATCHを使用してUserStatusをSに更新します。

ユーザー・アカウントのない内部リソースの作成

次の例は、cURLを使用してRESTリソースに対するPOSTリクエストを発行することによって、ユーザー・アカウントなしで内部リソースを作成する方法を示しています。そのような例は、「営業リソース・ライフサイクルの管理」を参照してください。

cURLコマンド

curl --user sales_cloud_user -X POST -d @example_request_payload.json https://servername.fa.us2.oraclecloud.com/crmRestApi/resources/11.13.19.01/resourceUsers

リクエスト本文の例

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

{
    "FirstName":"Katty",
    "LastName":"Smith",
    "ResourceEmail":"katty.smith@dnd.vision.com",
    "HireDate":"2018-08-20",
    "LegalEntity":"Vision Corporation",
    "BusinessUnit":"Vision Corporation Enterprise",
    "HRManagerEmailAddress" : "HR.Manager@dnd.vision.com",
    "ResourceOrgRoleCode":"SALES_MANAGER",
    "ResourceParentOrganizationName" : "HRManager_Org",
    "ResourceOrganizationName" : "kSmithOrg",
    "RawWorkPhoneNumber" : "6504461212",
    "AddressLine1" : "100 Oracle Parkway",
    "City" : "Redwood City",
    "State" : "CA",
    "PostalCode" : "944065",
    "Country" : "US",
    "ResourceStartDate" : "2018-12-05",
    "CreateUserAccountFlag" : "N"
}

レスポンス本文の例

次に、JSON形式のレスポンス本文の内容を示します。

{
 "PartyName": "Katty Smith",
 "ResourceType": "INDIVIDUAL",
 "FormattedAddress": "100 Oracle Parkway,REDWOOD CITY, CA 944065",
 "City": "Redwood City",
 "Country": "US",
 "PostalCode": "944065",
 "FirstName": "Katty",
 "LastName": "Smith",
 "ResourcePartyNumber": "Conta855676",
 "State": "CA",
 "ResourceEmail": "katty.smith@dnd.vision.com",
 "RawWorkPhoneNumber": "6504461212",
 "RawMobilePhoneNumber": null,
 "RawFaxNumber": null,
 "AddressLine1": "100 Oracle Parkway",
 "ResourceOrganizationName": "KSmithOrg",
 "ResourceOrganizationUsage": "SALES_RESOURCE_ORG",
 "ResourceOrgMemRoleEndDate": "4712-12-31",
 "ResourceOrgRoleCode":"SALES_MANAGER",
 "ResourceParentOrganizationName" : "HRManager_Org",
 "ResourceManagerFirstName": "Phil",
 "ResourceManagerLastName": "Gioco",
 "HRManagerEmailAddress": "HR.Manager@dnd.vision.com",
 "HireDate": "2018-08-20",
 "ResourceOrgMemRoleStartDate": "2018-08-20",
 "ResourceManagerPartyNumber": "100010034246635",
 "ResourceManagerPartyId": 100010034246635,
 "PersonNumber": "300100159661235",
 "BusinessUnit": "Vision Corporation Enterprise",
 "LegalEntity": "Vision Corporation",
 "UserStatus": "A",
 "PersonType": "EMP",
 "CreateUserAccountFlag": "N",
...
}

「トップに戻る」