機械翻訳について

ジャンプ先

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

サブスクリプション検証の更新

patch

/crmRestApi/resources/11.13.18.05/subscriptions/{SubscriptionNumber}/child/validateSubscription/{validateSubscriptionUniqID}

リクエスト

パス・パラメータ

• SubscriptionNumber(required): string
  サブスクリプションの代替識別子。
• validateSubscriptionUniqID(required): string
  これは、サブスクリプションの検証リソースのコンポジット・キーを構成し、サブスクリプションの検証のインスタンスを一意に識別するために使用される属性のハッシュ・キーです。 クライアントはハッシュ・キー値を生成しないでください。 かわりに、クライアントはサブスクリプションの検証コレクション・リソースを問い合せて、ハッシュ・キーを取得するためのサブスクリプションの検証の特定のインスタンスに移動する必要があります。

ヘッダー・パラメータ

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

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

• application/json

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

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

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

タイプ: object

ソースを表示

• ErrorSeverity: string
  最大長: 30

  エラーの重大度。
• MessageText: string
  最大長: 4000

  エラー・メッセージのテキスト。
• ObjectId: integer (int64)
  オブジェクトの一意の識別子。
• ObjectName: string
  最大長: 1000

  オブジェクトの名前。
• ObjectType: string
  最大長: 30

  オブジェクト・タイプ
• ObjectVersionNumber: 整数(int32)
  オブジェクト・バージョン番号。
• SubscriptionNumber: string
  最大長: 120

  サブスクリプション番号。

{
    "type":"object",
    "properties":{
        "ObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"The object type.",
            "nullable":false
        },
        "SubscriptionNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The subscription number.",
            "nullable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique identifier of the object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            }
        },
        "ErrorSeverity":{
            "maxLength":30,
            "type":"string",
            "description":"The severity of the error.",
            "nullable":false
        },
        "MessageText":{
            "maxLength":4000,
            "type":"string",
            "description":"The error message text.",
            "nullable":true
        },
        "ObjectName":{
            "maxLength":1000,
            "type":"string",
            "description":"The name of the object.",
            "nullable":true
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : subscriptions-validateSubscription-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  読取り専用: true

  最大長: 64

  レコードが作成された日付。
• CreationDate: string (date-time)
  読取り専用: true

  レコードを作成したユーザー。
• ErrorSeverity: string
  最大長: 30

  エラーの重大度。
• LastUpdateDate: string (date-time)
  読取り専用: true

  レコードが最後に更新された日付。
• LastUpdatedBy: string
  読取り専用: true

  最大長: 64

  レコードを最後に更新したユーザー。
• LastUpdateLogin: string
  読取り専用: true

  最大長: 32

  レコードを最後に更新したユーザーのログイン。
• links: array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• MessageText: string
  最大長: 4000

  エラー・メッセージのテキスト。
• ObjectId: integer (int64)
  オブジェクトの一意の識別子。
• ObjectName: string
  最大長: 1000

  オブジェクトの名前。
• ObjectType: string
  最大長: 30

  オブジェクト・タイプ
• ObjectVersionNumber: 整数(int32)
  オブジェクト・バージョン番号。
• SubscriptionNumber: string
  最大長: 120

  サブスクリプション番号。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the record.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "type":"string",
            "description":"The user who created the record.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"The date when the record was created.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "SubscriptionNumber":{
            "maxLength":120,
            "type":"string",
            "description":"The subscription number.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectId":{
            "type":"integer",
            "description":"The unique identifier of the object.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "ErrorSeverity":{
            "maxLength":30,
            "type":"string",
            "description":"The severity of the error.",
            "nullable":false,
            "x-queryable":true
        },
        "MessageText":{
            "maxLength":4000,
            "type":"string",
            "description":"The error message text.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectName":{
            "maxLength":1000,
            "type":"string",
            "description":"The name of the object.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectType":{
            "maxLength":30,
            "type":"string",
            "description":"The object type.",
            "nullable":false,
            "x-queryable":true
        },
        "ObjectVersionNumber":{
            "type":"integer",
            "description":"The object version number.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":9
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"The date when the record was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "maxLength":32,
            "type":"string",
            "description":"The login of the user who last updated the record.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

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

タイプ: array

タイトル: Links

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

ソースを表示

• Array of: object link

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

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

タイプ: object

ソースを表示

• href: string
  タイトル: hyperlink reference

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

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

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

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

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

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

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

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

タイプ: object

ソースを表示

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

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

「トップに戻る」