機械翻訳について

ジャンプ先

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

アクセス・グループ・メンバーの作成

post

/crmRestApi/resources/11.13.18.05/accessGroups/{AccessGroupNumber}/child/AccessGroupMembers

リクエスト

パス・パラメータ

• AccessGroupNumber(required): string
  アクセス・グループの代替キー識別子。 システム生成の一意の連番です。

ヘッダー・パラメータ

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

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

• application/json

リクエスト本文 - application/json ()

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

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

タイプ: object

ソースを表示

• AccessGroupId: integer (int64)
  タイトル: Access Group ID

  アクセス・グループの一意の識別子。
• AccessGroupMemberId: integer (int64)
  タイトル: Access Group Member ID

  アクセス・グループ・メンバーの一意の識別子。
• ManualAssignFlag: boolean
  タイトル: Member Type

  最大長: 1

  デフォルト値: true

  メンバーが手動でグループに追加されたかどうかを示します。
• PartyId: integer (int64)
  タイトル: Party ID

  アクセス・グループ・メンバーの一意の識別子。
• TypeCode: string
  タイトル: Type Code

  最大長: 30

  デフォルト値: ORA_ZCA_CUSTOM

  アクセス・グループ・メンバーの親アクセス・グループ・タイプを示すコード。

{
    "type":"object",
    "properties":{
        "ManualAssignFlag":{
            "title":"Member Type",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a member has been added to the group manually.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            }
        },
        "AccessGroupId":{
            "title":"Access Group ID",
            "type":"integer",
            "description":"The unique identifier of the access group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the access group member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        },
        "TypeCode":{
            "title":"Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the parent access group type of the access group member.",
            "nullable":false,
            "default":"ORA_ZCA_CUSTOM"
        },
        "AccessGroupMemberId":{
            "title":"Access Group Member ID",
            "type":"integer",
            "description":"The unique identifier of the access group member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            }
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : accessGroups-AccessGroupMembers-item-response

タイプ: object

ソースを表示

• AccessGroupId: integer (int64)
  タイトル: Access Group ID

  アクセス・グループの一意の識別子。
• AccessGroupMemberId: integer (int64)
  タイトル: Access Group Member ID

  アクセス・グループ・メンバーの一意の識別子。
• AccessGroupNumber: string
  タイトル: Group Number

  読取り専用: true

  最大長: 4000

  アクセス・グループ・メンバーが属するアクセス・グループの代替キー識別子。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  アクセス・グループ・メンバーを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  アクセス・グループ・メンバーが作成された日付。
• EmailAddress: string
  タイトル: E-Mail

  読取り専用: true

  最大長: 320

  アクセス・グループ・メンバーの電子メール・アドレス。
• FormattedPhoneNumber: string
  タイトル: Phone

  読取り専用: true

  アクセス・グループ・メンバーに関連付けられたリソースの電話番号。
• LastUpdateDate: string (date-time)
  タイトル: Last Update Date

  読取り専用: true

  アクセス・グループ・メンバーが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  アクセス・グループ・メンバーを最後に更新したユーザー。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

  アクセス・グループ・メンバーを最後に更新したユーザーのログイン詳細。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• ManualAssignFlag: boolean
  タイトル: Member Type

  最大長: 1

  デフォルト値: true

  メンバーが手動でグループに追加されたかどうかを示します。
• Name: string
  タイトル: Group Name

  読取り専用: true

  最大長: 4000

  アクセス・グループ・メンバーが属するアクセス・グループの名前。
• PartyId: integer (int64)
  タイトル: Party ID

  アクセス・グループ・メンバーの一意の識別子。
• PartyName: string
  タイトル: Resource Name

  読取り専用: true

  最大長: 255

  アクセス・グループ・メンバーの名前。
• PartyNumber: string
  タイトル: Resource Registry ID

  読取り専用: true

  最大長: 30

  リソースの代替キー識別子。
• RoleName: string
  タイトル: Resource Role

  読取り専用: true

  アクセス・グループ・メンバーに関連付けられたリソースのロール。
• TypeCode: string
  タイトル: Type Code

  最大長: 30

  デフォルト値: ORA_ZCA_CUSTOM

  アクセス・グループ・メンバーの親アクセス・グループ・タイプを示すコード。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the access group member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date when the access group member was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the access group member.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "TypeCode":{
            "title":"Type Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the parent access group type of the access group member.",
            "nullable":false,
            "default":"ORA_ZCA_CUSTOM",
            "x-queryable":true
        },
        "ManualAssignFlag":{
            "title":"Member Type",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether a member has been added to the group manually.",
            "nullable":false,
            "default":true,
            "x-hints":{
                "controlType":"choice"
            },
            "x-queryable":true
        },
        "PartyName":{
            "title":"Resource Name",
            "maxLength":255,
            "type":"string",
            "description":"The name of the access group member.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "AccessGroupId":{
            "title":"Access Group ID",
            "type":"integer",
            "description":"The unique identifier of the access group.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EmailAddress":{
            "title":"E-Mail",
            "maxLength":320,
            "type":"string",
            "description":"The email address of the access group member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "protectionKey":"EmailEO.EmailAddress",
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ],
                "protectionObjectTitle":"Email",
                "protectionState":"TOKENIZED",
                "protectionAttributeTitle":"Email"
            },
            "x-queryable":true
        },
        "AccessGroupMemberId":{
            "title":"Access Group Member ID",
            "type":"integer",
            "description":"The unique identifier of the access group member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Name":{
            "title":"Group Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the access group to which the access group member belongs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyNumber":{
            "title":"Resource Registry ID",
            "maxLength":30,
            "type":"string",
            "description":"The alternate key identifier for the resource.",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "RoleName":{
            "title":"Resource Role",
            "type":"string",
            "description":"The role of the resource associated with the access group member.",
            "nullable":true,
            "readOnly":true,
            "x-hints":{
                "operators":[
                    "STARTSWITH",
                    "ENDSWITH",
                    "=",
                    "<>",
                    "CONTAINS",
                    "DOESNOTCONTAIN",
                    "ISBLANK",
                    "ISNOTBLANK"
                ]
            },
            "x-queryable":true
        },
        "PartyId":{
            "title":"Party ID",
            "type":"integer",
            "description":"The unique identifier of the access group member.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccessGroupNumber":{
            "title":"Group Number",
            "maxLength":4000,
            "type":"string",
            "description":"The alternate key identifier of the access group to which the access group member belongs.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "FormattedPhoneNumber":{
            "title":"Phone",
            "type":"string",
            "description":"The phone number of the resource associated with the access group member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Update Date",
            "type":"string",
            "description":"The date when the access group member was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The login details of the user who last updated the access group member.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

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

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

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

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

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

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

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

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

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

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

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

タイプ: object

ソースを表示

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

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

「トップに戻る」