機械翻訳について

ジャンプ先

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

リソース容量の作成

post

/crmRestApi/resources/11.13.18.05/resourceCapacities

リクエスト

ヘッダー・パラメータ

• 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

ソースを表示

• CapacityNumber: string
  タイトル: Resource Capacity Number

  最大長: 30

  リソース容量の代替またはパブリックの一意の識別子。
• ChannelTypeCd: string
  タイトル: Channel Type

  最大長: 30

  リソースが使用できるチャネル・タイプ。
• DecRoutingFlag: boolean
  最大長: 1

  このオブジェクト・タイプをデジタル・エンゲージメント・チャネルにルーティングする必要があるかどうかを示します。
• MaximumCapacity: 整数(int32)
  タイトル: Capacity

  チャネル・タイプおよびオブジェクト・タイプのリソースの最大容量。
• ObjectTypeCd: string
  タイトル: Business Objects

  最大長: 30

  リソースに割り当てることができるオブジェクト・タイプ。
• PartyId: integer (int64)
  タイトル: Resource ID

  リソースの一意の識別子。

{
    "type":"object",
    "properties":{
        "CapacityNumber":{
            "title":"Resource Capacity Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate or public unique identifer of the resource capacity.",
            "nullable":false
        },
        "PartyId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of a resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            }
        },
        "DecRoutingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this object type should be routed to Digital Engagement Channels.",
            "nullable":true
        },
        "ObjectTypeCd":{
            "title":"Business Objects",
            "maxLength":30,
            "type":"string",
            "description":"The object type that you can assign to a resource.",
            "nullable":true
        },
        "MaximumCapacity":{
            "title":"Capacity",
            "type":"integer",
            "description":"The maximum capacity for a resource in a channel type and object type.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            }
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":30,
            "type":"string",
            "description":"The channel type a resource can use.",
            "nullable":false
        }
    }
}

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

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

タイプ: object

ソースを表示

• CapacityId: integer (int64)
  タイトル: Capacity ID

  読取り専用: true

  リソース生産能力の一意の識別子。
• CapacityNumber: string
  タイトル: Resource Capacity Number

  最大長: 30

  リソース容量の代替またはパブリックの一意の識別子。
• ChannelTypeCd: string
  タイトル: Channel Type

  最大長: 30

  リソースが使用できるチャネル・タイプ。
• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

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

  読取り専用: true

  リソース生産能力が作成された日時。
• DecRoutingFlag: boolean
  最大長: 1

  このオブジェクト・タイプをデジタル・エンゲージメント・チャネルにルーティングする必要があるかどうかを示します。
• LastUpdateDate: string (date-time)
  タイトル: Last Updated Date

  読取り専用: true

  リソース生産能力が最後に更新された日時。
• LastUpdatedBy: string
  タイトル: Last Updated By

  読取り専用: true

  最大長: 64

  リソース容量を最後に更新したユーザーのセッション・ログイン。
• LastUpdateLogin: string
  タイトル: Last Update Login

  読取り専用: true

  最大長: 32

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

  リソース・インスタンスに関連付けられたリンク関係。
• MaximumCapacity: 整数(int32)
  タイトル: Capacity

  チャネル・タイプおよびオブジェクト・タイプのリソースの最大容量。
• ObjectTypeCd: string
  タイトル: Business Objects

  最大長: 30

  リソースに割り当てることができるオブジェクト・タイプ。
• PartyId: integer (int64)
  タイトル: Resource ID

  リソースの一意の識別子。
• ResourceNumber: string
  タイトル: Resource Number

  読取り専用: true

  最大長: 30

  リソースの代替一意識別子。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The session login of the user who last updated the resource capacity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CapacityId":{
            "title":"Capacity ID",
            "type":"integer",
            "description":"The unique identifier of the resource capacity.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the resource capacity was created.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CapacityNumber":{
            "title":"Resource Capacity Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate or public unique identifer of the resource capacity.",
            "nullable":false,
            "x-queryable":true
        },
        "CreatedBy":{
            "title":"Created By",
            "maxLength":64,
            "type":"string",
            "description":"The user who created the resource capacity.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "MaximumCapacity":{
            "title":"Capacity",
            "type":"integer",
            "description":"The maximum capacity for a resource in a channel type and object type.",
            "format":"int32",
            "nullable":false,
            "x-hints":{
                "precision":5
            },
            "x-queryable":true
        },
        "ResourceNumber":{
            "title":"Resource Number",
            "maxLength":30,
            "type":"string",
            "description":"The alternate unique identifier of the resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "PartyId":{
            "title":"Resource ID",
            "type":"integer",
            "description":"The unique identifier of a resource.",
            "format":"int64",
            "nullable":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "DecRoutingFlag":{
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether this object type should be routed to Digital Engagement Channels.",
            "nullable":true,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Business Objects",
            "maxLength":30,
            "type":"string",
            "description":"The object type that you can assign to a resource.",
            "nullable":true,
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "ChannelTypeCd":{
            "title":"Channel Type",
            "maxLength":30,
            "type":"string",
            "description":"The channel type a resource can use.",
            "nullable":false,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the resource capacity was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The user who last updated the resource capacity.",
            "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."
        }
    }
}

「トップに戻る」