機械翻訳について

ジャンプ先

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

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

post

/crmRestApi/resources/11.13.18.05/accessGroupRules

リクエスト

ヘッダー・パラメータ

• Metadata-Context:
  REST APIがランタイム・カスタマイズをサポートしている場合、サービスのシェイプはランタイム中に変更される可能性があります。 RESTクライアントは、これらの変更から自身を分離したり、このヘッダーを指定して最新バージョンのAPIと対話することを選択できます。 次に例を示します : Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  RESTクライアントとサービスの間のプロトコル・バージョン。 クライアントがリクエストでこのヘッダーを指定しない場合、サーバーはAPIのデフォルト・バージョンを選択します。
• Upsert-Mode:
  次のいずれかの値が含まれます: trueまたはfalse。 trueの場合、サーバーは作成操作ではなくアップサート操作を実行します。 アップサート操作中、サーバーはペイロードに一致する既存のリソースを検索しようとします。 一致が見つかった場合、サーバーは、新しいリソースを作成するのではなく、既存のリソースを更新します。 見つからないかfalse (デフォルト)の場合、サーバーは作成操作を実行します。 アップサート操作は、有効日RESTリソースではサポートされていないことに注意してください。

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

• application/json

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

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

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

タイプ: object

ソースを表示

• AccessGroupCandidate: array Access Group Rule Candidates
  タイトル: Access Group Rule Candidates

  アクセス・グループ・ルール候補リソースは、アクセス・グループ候補の表示、作成、更新および削除に使用されます。 ルールに関連付けられたアクセス・グループ・レコードを提供します。
• AccessGroupCondition: array Access Group Rule Conditions
  タイトル: Access Group Rule Conditions

  アクセス・グループ条件リソースは、グループ・ルール条件の表示、作成、更新および削除に使用されます。 これらはルールに関連付けられた条件です。
• ActiveFlag: boolean
  タイトル: Active

  最大長: 1

  デフォルト値: false

  アクセス・グループ・ルールがアクティブかどうかを示します。
• ConditionCode: string
  タイトル: Condition Code

  最大長: 240

  事前定義済ルールのコード。 ハイブリッド・ルールにのみ適用されます。
• Description: string
  タイトル: Rule Description

  最大長: 255

  ルールの説明。
• MatchingType: string
  タイトル: Matching Type

  最大長: 30

  条件の一致タイプ(OR/AND)。
• Object(required): string
  タイトル: Object

  最大長: 75

  このルールを作成する必要があるオブジェクト名。
• PredefinedFlag: boolean
  タイトル: Predefined

  最大長: 1

  デフォルト値: false

  ルールがシード済かユーザー定義かを示します。
• RuleId: integer (int64)
  タイトル: Rule ID

  ルールの一意の識別子。
• RuleName(required): string
  タイトル: Rule Name

  最大長: 200

  ルールの表示名。
• RuleNumber: string
  タイトル: Rule Number

  最大長: 30

  ルールのルール番号。 ユーザーは、この値を指定することも、システム生成の番号を指定することもできます。

{
    "required":[
        "Object",
        "RuleName"
    ],
    "type":"object",
    "properties":{
        "MatchingType":{
            "title":"Matching Type",
            "maxLength":30,
            "type":"string",
            "description":"The matching type for the conditions (OR/AND).",
            "nullable":true
        },
        "Description":{
            "title":"Rule Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the rule.",
            "nullable":true
        },
        "PredefinedFlag":{
            "title":"Predefined",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rule is seeded or user defined.",
            "nullable":true,
            "default":false
        },
        "AccessGroupCondition":{
            "title":"Access Group Rule Conditions",
            "type":"array",
            "description":"The access group conditions resource is used to view, create, update, and delete the group rule conditions. These are conditions associated with a rule.",
            "items":{
                "$ref":"#/components/schemas/accessGroupRules-AccessGroupCondition-item-post-request"
            }
        },
        "RuleId":{
            "title":"Rule ID",
            "type":"integer",
            "description":"The unique identifier of the rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "AccessGroupCandidate":{
            "title":"Access Group Rule Candidates",
            "type":"array",
            "description":"The access group rule candidates resource is used to view, create, update, and delete the access group candidates. It provides access group records associated with a rule.",
            "items":{
                "$ref":"#/components/schemas/accessGroupRules-AccessGroupCandidate-item-post-request"
            }
        },
        "RuleNumber":{
            "title":"Rule Number",
            "maxLength":30,
            "type":"string",
            "description":"The rule number of the rule. The user can either provide this value or the system generated number.",
            "nullable":true
        },
        "Object":{
            "title":"Object",
            "maxLength":75,
            "type":"string",
            "description":"The object name for which this rule needs to be created.",
            "nullable":false
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the access group rule is active.",
            "nullable":true,
            "default":false
        },
        "RuleName":{
            "title":"Rule Name",
            "maxLength":200,
            "type":"string",
            "description":"The display name of the rule.",
            "nullable":false
        },
        "ConditionCode":{
            "title":"Condition Code",
            "maxLength":240,
            "type":"string",
            "description":"The code for predefined rules. It is applicable only for Hybrid rules.",
            "nullable":true
        }
    }
}

ネストされたスキーマ : アクセス・グループ・ルール候補

タイプ: array

タイトル: Access Group Rule Candidates

アクセス・グループ・ルール候補リソースは、アクセス・グループ候補の表示、作成、更新および削除に使用されます。 ルールに関連付けられたアクセス・グループ・レコードを提供します。

ソースを表示

• Array of: object accessGroupRules-AccessGroupCandidate-item-post-request

{
    "title":"Access Group Rule Candidates",
    "type":"array",
    "description":"The access group rule candidates resource is used to view, create, update, and delete the access group candidates. It provides access group records associated with a rule.",
    "items":{
        "$ref":"#/components/schemas/accessGroupRules-AccessGroupCandidate-item-post-request"
    }
}

ネストされたスキーマ : アクセス・グループ・ルール条件

タイプ: array

タイトル: Access Group Rule Conditions

アクセス・グループ条件リソースは、グループ・ルール条件の表示、作成、更新および削除に使用されます。 これらはルールに関連付けられた条件です。

ソースを表示

• Array of: object schema

{
    "title":"Access Group Rule Conditions",
    "type":"array",
    "description":"The access group conditions resource is used to view, create, update, and delete the group rule conditions. These are conditions associated with a rule.",
    "items":{
        "$ref":"#/components/schemas/accessGroupRules-AccessGroupCondition-item-post-request"
    }
}

ネストされたスキーマ : accessGroupRules-AccessGroupCandidate-item-post-request

タイプ: object

ソースを表示

• AccessLevel: string
  タイトル: Access Level

  最大長: 255

  デフォルト値: READ

  ルールに関連付けられたアクセス・レベル。
• EnableFlag: boolean
  タイトル: Enable

  最大長: 1

  アクセス・グループの候補者がこのルールに対して使用可能かどうかを示します。
• RuleCandidateId: integer (int64)
  タイトル: Rule Candidate ID

  ルール候補の一意の識別子。
• RuleCandidateNumber: string
  タイトル: Rule Candidate Number

  最大長: 30

  アクセス・グループ・ルール候補の内部番号。

{
    "type":"object",
    "properties":{
        "RuleCandidateNumber":{
            "title":"Rule Candidate Number",
            "maxLength":30,
            "type":"string",
            "description":"The internal number for Access Group Rule Candidate.",
            "nullable":true
        },
        "RuleCandidateId":{
            "title":"Rule Candidate ID",
            "type":"integer",
            "description":"The unique identifier of the rule candidate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "EnableFlag":{
            "title":"Enable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the Access Group candidate is enabled for this rule.",
            "nullable":true
        },
        "AccessLevel":{
            "title":"Access Level",
            "maxLength":255,
            "type":"string",
            "description":"The access level associated with the rule.",
            "nullable":true,
            "default":"READ"
        }
    }
}

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

タイプ: object

ソースを表示

• Object: string
  タイトル: Object

  最大長: 64

  ルール条件の作成が必要なオブジェクト。
• ObjectAttributeCode: string
  タイトル: Object Attribute Code

  最大長: 80

  ルール条件の作成が必要な属性。
• Operator: string
  タイトル: Operator

  最大長: 20

  属性に適用可能な演算子。 IN演算子およびNOT IN演算子の更新は許可されていません。 既存のレコードを削除し、IN演算子とNOT IN演算子の新しいレコードを作成する必要があります。
• RuleConditionNumber: string
  タイトル: Rule Condition Number

  最大長: 30

  ルール条件番号。
• Value: string
  タイトル: Value

  最大長: 255

  条件の値。

{
    "type":"object",
    "properties":{
        "Operator":{
            "title":"Operator",
            "maxLength":20,
            "type":"string",
            "description":"The operator applicable for attribute. Update of IN and NOT IN operators are not allowed. You should delete the existing record and create a new one for IN and NOT IN operator.",
            "nullable":false
        },
        "Value":{
            "title":"Value",
            "maxLength":255,
            "type":"string",
            "description":"The value of condition.",
            "nullable":true
        },
        "RuleConditionNumber":{
            "title":"Rule Condition Number",
            "maxLength":30,
            "type":"string",
            "description":"The rule condition number.",
            "nullable":true
        },
        "Object":{
            "title":"Object",
            "maxLength":64,
            "type":"string",
            "description":"The object for which rule condition needs to be created.",
            "nullable":false
        },
        "ObjectAttributeCode":{
            "title":"Object Attribute Code",
            "maxLength":80,
            "type":"string",
            "description":"The attribute for which rule condition needs to be created.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• AccessGroupCandidate: array Access Group Rule Candidates
  タイトル: Access Group Rule Candidates

  アクセス・グループ・ルール候補リソースは、アクセス・グループ候補の表示、作成、更新および削除に使用されます。 ルールに関連付けられたアクセス・グループ・レコードを提供します。
• AccessGroupCondition: array Access Group Rule Conditions
  タイトル: Access Group Rule Conditions

  アクセス・グループ条件リソースは、グループ・ルール条件の表示、作成、更新および削除に使用されます。 これらはルールに関連付けられた条件です。
• ActiveFlag: boolean
  タイトル: Active

  最大長: 1

  デフォルト値: false

  アクセス・グループ・ルールがアクティブかどうかを示します。
• ConditionCode: string
  タイトル: Condition Code

  最大長: 240

  事前定義済ルールのコード。 ハイブリッド・ルールにのみ適用されます。
• ConditionName: string
  タイトル: Condition

  読取り専用: true

  最大長: 1000

  事前定義済ルールの条件名。 ハイブリッド・ルールにのみ適用されます。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

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

  読取り専用: true

  ルールが作成された日付。
• DeleteFlag: boolean
  タイトル: Delete

  読取り専用: true

  ルールを削除できるかどうかを示します。
• Description: string
  タイトル: Rule Description

  最大長: 255

  ルールの説明。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  ルールが最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  ルールを最後に更新したユーザー。
• links: array Links
  タイトル: Links

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

  最大長: 30

  条件の一致タイプ(OR/AND)。
• Object: string
  タイトル: Object

  最大長: 75

  このルールを作成する必要があるオブジェクト名。
• ObjectCode: string
  タイトル: Object Code

  読取り専用: true

  最大長: 75

  このルールを作成する必要があるオブジェクト・コード。
• PredefinedFlag: boolean
  タイトル: Predefined

  最大長: 1

  デフォルト値: false

  ルールがシード済かユーザー定義かを示します。
• RuleId: integer (int64)
  タイトル: Rule ID

  ルールの一意の識別子。
• RuleName: string
  タイトル: Rule Name

  最大長: 200

  ルールの表示名。
• RuleNumber: string
  タイトル: Rule Number

  最大長: 30

  ルールのルール番号。 ユーザーは、この値を指定することも、システム生成の番号を指定することもできます。
• UpdateFlag: boolean
  タイトル: Update

  読取り専用: true

  ルールを更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which rule 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 rule.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Description":{
            "title":"Rule Description",
            "maxLength":255,
            "type":"string",
            "description":"The description of the rule.",
            "nullable":true,
            "x-queryable":true
        },
        "PredefinedFlag":{
            "title":"Predefined",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the rule is seeded or user defined.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "AccessGroupCondition":{
            "title":"Access Group Rule Conditions",
            "type":"array",
            "description":"The access group conditions resource is used to view, create, update, and delete the group rule conditions. These are conditions associated with a rule.",
            "items":{
                "$ref":"#/components/schemas/accessGroupRules-AccessGroupCondition-item-response"
            }
        },
        "RuleId":{
            "title":"Rule ID",
            "type":"integer",
            "description":"The unique identifier of the rule.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "AccessGroupCandidate":{
            "title":"Access Group Rule Candidates",
            "type":"array",
            "description":"The access group rule candidates resource is used to view, create, update, and delete the access group candidates. It provides access group records associated with a rule.",
            "items":{
                "$ref":"#/components/schemas/accessGroupRules-AccessGroupCandidate-item-response"
            }
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":75,
            "type":"string",
            "description":"The object code for which this rule needs to be created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ConditionName":{
            "title":"Condition",
            "maxLength":1000,
            "type":"string",
            "description":"The condition name for the predefined rules. It is applicable only for Hybrid rules.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ActiveFlag":{
            "title":"Active",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the access group rule is active.",
            "nullable":true,
            "default":false,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the rule can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "ConditionCode":{
            "title":"Condition Code",
            "maxLength":240,
            "type":"string",
            "description":"The code for predefined rules. It is applicable only for Hybrid rules.",
            "nullable":true,
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the rule can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "MatchingType":{
            "title":"Matching Type",
            "maxLength":30,
            "type":"string",
            "description":"The matching type for the conditions (OR/AND).",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleNumber":{
            "title":"Rule Number",
            "maxLength":30,
            "type":"string",
            "description":"The rule number of the rule. The user can either provide this value or the system generated number.",
            "nullable":true,
            "x-queryable":true
        },
        "Object":{
            "title":"Object",
            "maxLength":75,
            "type":"string",
            "description":"The object name for which this rule needs to be created.",
            "nullable":false,
            "x-queryable":true
        },
        "RuleName":{
            "title":"Rule Name",
            "maxLength":200,
            "type":"string",
            "description":"The display name of the rule.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the rule was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

ネストされたスキーマ : アクセス・グループ・ルール候補

タイプ: array

タイトル: Access Group Rule Candidates

アクセス・グループ・ルール候補リソースは、アクセス・グループ候補の表示、作成、更新および削除に使用されます。 ルールに関連付けられたアクセス・グループ・レコードを提供します。

ソースを表示

• Array of: object accessGroupRules-AccessGroupCandidate-item-response

{
    "title":"Access Group Rule Candidates",
    "type":"array",
    "description":"The access group rule candidates resource is used to view, create, update, and delete the access group candidates. It provides access group records associated with a rule.",
    "items":{
        "$ref":"#/components/schemas/accessGroupRules-AccessGroupCandidate-item-response"
    }
}

ネストされたスキーマ : アクセス・グループ・ルール条件

タイプ: array

タイトル: Access Group Rule Conditions

アクセス・グループ条件リソースは、グループ・ルール条件の表示、作成、更新および削除に使用されます。 これらはルールに関連付けられた条件です。

ソースを表示

• Array of: object accessGroupRules-AccessGroupCondition-item-response

{
    "title":"Access Group Rule Conditions",
    "type":"array",
    "description":"The access group conditions resource is used to view, create, update, and delete the group rule conditions. These are conditions associated with a rule.",
    "items":{
        "$ref":"#/components/schemas/accessGroupRules-AccessGroupCondition-item-response"
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

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

ネストされたスキーマ : accessGroupRules-AccessGroupCandidate-item-response

タイプ: object

ソースを表示

• AccessGroupName: string
  タイトル: Access Group Name

  読取り専用: true

  最大長: 4000

  アクセス・グループ候補の名前。
• AccessGroupNumber: string
  タイトル: Access Group Number

  読取り専用: true

  最大長: 4000

  このルールに関連付けられているアクセス・グループ番号。
• AccessLevel: string
  タイトル: Access Level

  最大長: 255

  デフォルト値: READ

  ルールに関連付けられたアクセス・レベル。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  グループ候補を作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  グループ候補者が作成された日付。
• DeleteFlag: boolean
  タイトル: Delete

  読取り専用: true

  候補者を削除できるかどうかを示します。
• EnableFlag: boolean
  タイトル: Enable

  最大長: 1

  アクセス・グループの候補者がこのルールに対して使用可能かどうかを示します。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  グループ候補者が最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  グループ候補を最後に更新したユーザー。
• links: array Links
  タイトル: Links

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

  読取り専用: true

  アクセス・グループ候補がシードされているかどうかを示します。
• RuleCandidateId: integer (int64)
  タイトル: Rule Candidate ID

  ルール候補の一意の識別子。
• RuleCandidateNumber: string
  タイトル: Rule Candidate Number

  最大長: 30

  アクセス・グループ・ルール候補の内部番号。
• RuleNumber: string
  タイトル: Rule Number

  読取り専用: true

  最大長: 30

  このアクセス・グループ候補が属するルール番号。
• UpdateFlag: boolean
  タイトル: Update

  読取り専用: true

  候補者を更新できるかどうかを示します。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the group candidate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the group candidate 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 group candidate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PredefinedFlag":{
            "title":"Predefined",
            "type":"boolean",
            "description":"Indicates whether the Access Group Candidate is seeded or not.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "AccessGroupName":{
            "title":"Access Group Name",
            "maxLength":4000,
            "type":"string",
            "description":"The name of the Access Group candidate.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleCandidateId":{
            "title":"Rule Candidate ID",
            "type":"integer",
            "description":"The unique identifier of the rule candidate.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnableFlag":{
            "title":"Enable",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the Access Group candidate is enabled for this rule.",
            "nullable":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the candidate can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "AccessLevel":{
            "title":"Access Level",
            "maxLength":255,
            "type":"string",
            "description":"The access level associated with the rule.",
            "nullable":true,
            "default":"READ",
            "x-queryable":true
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the candidate can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "RuleCandidateNumber":{
            "title":"Rule Candidate Number",
            "maxLength":30,
            "type":"string",
            "description":"The internal number for Access Group Rule Candidate.",
            "nullable":true,
            "x-queryable":true
        },
        "AccessGroupNumber":{
            "title":"Access Group Number",
            "maxLength":4000,
            "type":"string",
            "description":"The access group number associated with this rule.",
            "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"
            }
        },
        "RuleNumber":{
            "title":"Rule Number",
            "maxLength":30,
            "type":"string",
            "description":"The rule number for which this Access Group candidate belongs to.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the group candidate was last updated.",
            "format":"date-time",
            "nullable":false,
            "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."
        }
    }
}

ネストされたスキーマ : accessGroupRules-AccessGroupCondition-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  グループ条件を作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  グループ条件が作成された日付。
• DeleteFlag: boolean
  タイトル: Delete

  読取り専用: true

  グループ条件を削除できるかどうかを示します。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  グループ条件が最後に更新された日付。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  グループ条件を最後に更新したユーザー。
• links: array Links
  タイトル: Links

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

  最大長: 64

  ルール条件の作成が必要なオブジェクト。
• ObjectAttributeCode: string
  タイトル: Object Attribute Code

  最大長: 80

  ルール条件の作成が必要な属性。
• ObjectAttributeName: string
  タイトル: Object Attribute Name

  読取り専用: true

  条件の作成が必要なオブジェクト属性の表示名。
• ObjectCode: string
  タイトル: Object Code

  読取り専用: true

  最大長: 75

  ルール条件の作成が必要なオブジェクト・コード。
• Operator: string
  タイトル: Operator

  最大長: 20

  属性に適用可能な演算子。 IN演算子およびNOT IN演算子の更新は許可されていません。 既存のレコードを削除し、IN演算子とNOT IN演算子の新しいレコードを作成する必要があります。
• RuleConditionNumber: string
  タイトル: Rule Condition Number

  最大長: 30

  ルール条件番号。
• RuleNumber: string
  タイトル: Rule Number

  読取り専用: true

  最大長: 30

  条件を作成する必要があるルール番号。
• UpdateFlag: boolean
  タイトル: Update

  読取り専用: true

  グループ条件を更新できるかどうかを示します。
• Value: string
  タイトル: Value

  最大長: 255

  条件の値。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the group condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "Operator":{
            "title":"Operator",
            "maxLength":20,
            "type":"string",
            "description":"The operator applicable for attribute. Update of IN and NOT IN operators are not allowed. You should delete the existing record and create a new one for IN and NOT IN operator.",
            "nullable":false,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date on which the group condition 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 group condition.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectAttributeCode":{
            "title":"Object Attribute Code",
            "maxLength":80,
            "type":"string",
            "description":"The attribute for which rule condition needs to be created.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectCode":{
            "title":"Object Code",
            "maxLength":75,
            "type":"string",
            "description":"The object code for which rule condition needs to be created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectAttributeName":{
            "title":"Object Attribute Name",
            "type":"string",
            "description":"The object attribute display name for which condition needs to be created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Delete",
            "type":"boolean",
            "description":"Indicates whether the group condition can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "title":"Update",
            "type":"boolean",
            "description":"Indicates whether the group condition can be updated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "Value":{
            "title":"Value",
            "maxLength":255,
            "type":"string",
            "description":"The value of condition.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "RuleNumber":{
            "title":"Rule Number",
            "maxLength":30,
            "type":"string",
            "description":"The rule number for which condition needs to be created.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "RuleConditionNumber":{
            "title":"Rule Condition Number",
            "maxLength":30,
            "type":"string",
            "description":"The rule condition number.",
            "nullable":true,
            "x-queryable":true
        },
        "Object":{
            "title":"Object",
            "maxLength":64,
            "type":"string",
            "description":"The object for which rule condition needs to be created.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date on which the group condition was last updated.",
            "format":"date-time",
            "nullable":false,
            "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"
    }
}

リンク

AccessGroupCandidate

操作: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCandidate

パラメータ:

• RuleNumber: $request.path.RuleNumber

アクセス・グループ・ルール候補リソースは、アクセス・グループ候補の表示、作成、更新および削除に使用されます。 ルールに関連付けられたアクセス・グループ・レコードを提供します。

AccessGroupCondition

操作: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/child/AccessGroupCondition

パラメータ:

• RuleNumber: $request.path.RuleNumber

アクセス・グループ条件リソースは、グループ・ルール条件の表示、作成、更新および削除に使用されます。 これらはルールに関連付けられた条件です。

deleteAndPublishRule

操作: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/action/deleteAndPublishRule

パラメータ:

• RuleNumber: $request.path.RuleNumber

プロファイル・オプションに基づいて、指定されたルールが削除され、その後MRAまたはOBRエンジンに公開されます。

isRulePublished

操作: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/action/isRulePublished

パラメータ:

• RuleNumber: $request.path.RuleNumber

ルールPUIDに基づいて、ルールが公開されるとアクションが戻されます。

publishRule

操作: /crmRestApi/resources/11.13.18.05/accessGroupRules/{RuleNumber}/action/publishRule

パラメータ:

• RuleNumber: $request.path.RuleNumber

プロファイル・オプションに基づいて、指定されたルールがMRAまたはOBRエンジンに公開されます。

「トップに戻る」