機械翻訳について

ジャンプ先

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

すべてのオーバーフロー・キューの取得

get

/crmRestApi/resources/11.13.18.05/queues/{QueueId}/child/overflowQueues

リクエスト

パス・パラメータ

• QueueId(required): integer(int64)
  キューの一意の識別子。

問合せパラメータ

• dependency: string
  このパラメータは、レスポンスの生成後に設定およびロールバックされるフィールドである依存関係を指定します。 通常、これらは属性変更の影響をプレビューするために使用されます。 このパラメータで指定されたフィールドは、常に問題のリソース・インスタンスで設定されます。 子リソース・コレクションがリクエストされ、パラメータが設定されると、リソース・コレクション・ペイロードを生成する前にフィールドが親リソース・インスタンスに設定されます。 この問合せパラメータの値は、依存性フィールドのセットです。 例: dependency=ProductId=2
  
  フォーマット: <attr1>=<val1>,<attr2>=<value2>
• expand: string
  このパラメータを指定すると、指定した子がリソース・ペイロードに含まれます(リンクのみでなく)。 この問合せパラメータの値は"all"または""です。 カンマをセパレータとして使用して、複数の子を指定できます。 例: ?expand=Employees,Localizations. ネストされた子は、"Child.NestedChild"の書式に従って指定することもできます(例): ?expand=Employees.Managers). ネストされた子が指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?expand=Employees.Managers"は"?expand=Employees,Employees.Managers"と同じです(これにより、従業員とマネージャが展開されます)。
• fields: string
  このパラメータは、リソース・フィールドをフィルタします。 指定されたフィールドのみが返されます。つまり、フィールドが指定されていない場合、フィールドは返されません(リンクのみを取得する場合に便利です)。 間接子リソースが指定されている場合(例): Employees.Managers)。欠落している子は暗黙的に処理されます。 たとえば、"?fields=Employees.Managers:Empname"は"?fields=;Employees:;Employees.Managers:Empname" (これはマネージャの"Empname"フィールドのみを返す)と同じです。この問合せパラメータの値は、リソース・フィールドのリストです。 属性は直接にすることができます(例): 従業員または間接(例): Employees.Managers) child. 拡張問合せパラメータと組み合せることはできません。 両方を指定した場合、フィールドのみが考慮されます。
  
  フォーマット : ?fields=Attribute1,Attribute2
  
  子リソースのフィールドの書式 : ?fields=Accessor1:Attribute1,Attribute2
• finder: string
  コレクションを検索するための事前定義済ファインダとして使用されます。
  
  フォーマット : ?finder=<finderName>;<variableName>=<variableValue>,<variableName2>=<variableValue2>
  
  使用可能なファインダ名および対応するファインダ変数を次に示します:
  
  

  • PrimaryKey : 特定の主キーでオーバーフロー・キューを検索します。
    ファインダ変数:
    • QueueResourceId; integer;オーバーフロー・キュー・リソースの一意の識別子。
  • QueueOverflowAltKeyFinder: 指定された公開一意識別子を持つオーバーフロー・キューを検索します。ただし、指定された公開一意識別子によって識別されるキューに関連付けられている場合のみです。
    ファインダ変数:
    • OverflowQueueNumber; string.
    • QueueNumber; string.
• limit: integer
  このパラメータは、リソース・コレクション内で返されるリソースの数を制限します。 制限がリソース数を超えると、フレームワークは使用可能なリソースのみを返します。
• links: string
  このパラメータは、単一のリソースまたはリソース・コレクションへのアクセス中に特定のリンクのみを表示するために使用できます。 パラメータ値書式は、次のカンマ区切りリストです : <link_relation>
  
  例:
  self,canonical
  
• offset: integer
  リソース・コレクションの開始位置を定義するために使用します。 オフセットがリソース数を超えると、リソースは返されません。 デフォルト値は0です。
• onlyData: boolean
  リソース・アイテム・ペイロードは、データのみを含めるようにフィルタされます(リンク・セクションなどは含まれません)。
• orderBy: string
  このパラメータは、指定されたフィールドに基づいてリソース・コレクションを順序付けます。 パラメータ値は、属性名のカンマ区切りの文字列で、それぞれオプションでコロンと「asc」または「desc」が続きます。 昇順の場合は「asc」、降順の場合は「desc」を指定します。 デフォルト値は「asc」です。 たとえば、?orderBy=field1:asc,field2:descです
• q: string
  この問合せパラメータは、where句を定義します。 リソース・コレクションは、指定された式を使用して問い合せられます。 この問合せパラメータの値は、1つ以上の式です。 例 : ?q=部門番号>=10および<= 30;Loc!=NY
  
  フォーマット : ?q=expression1;expression2
  
  次の問合せ可能属性を使用して、q問合せパラメータを使用してこの収集リソースをフィルタできます:
  

  • CreatedBy; string;オーバーフロー・キュー・リソースを作成したユーザー。
  • CreationDate; string;オーバーフロー・キュー・リソースが作成された日時。
  • EnabledFlag; boolean;オーバーフロー・キュー・リソースが有効かどうかを示します。 有効な場合、値はY、それ以外の場合はNです。
  • LastUpdateDate; string;オーバーフロー・キュー・リソースが最後に更新された日時。
  • LastUpdateLogin; string;オーバーフロー・キュー・リソースを最後に更新したユーザーに関連付けられたアプリケーション・ログイン。
  • LastUpdatedBy; string; オーバーフロー・キュー・リソースを最後に更新したユーザー。
  • ObjectId; integer; キュー・リソースとして追加されたオーバーフロー・キューの一意の識別子。
  • ObjectTypeCd; string; キュー・リソースが個別、チームまたはオーバーフロー・キューであるかどうかを示すコード。
  • OverflowQueueId; integer; キューに関連付けられたオーバーフロー・キューの一意の識別子。
  • OverflowQueueName; string;オーバーフロー・キューの名前。
  • OverflowQueueNumber; string;キューに関連付けられたオーバーフロー・キューの公開一意識別子。
  • OverflowQueueStripeCd; string; オーバーフロー・キューのアプリケーション・コンテキストを示すコード。
  • 優先度、整数、オーバーフロー・キュー・リソースの優先度。
  • QueueId; integer;キューの一意の識別子。
  • QueueName; string; このオーバーフロー・キューが関連付けられているキューの名前。
  • QueueNumber; string; このオーバーフロー・キューが関連付けられているキューの公開一意識別子。
  • QueueResourceId; integer;オーバーフロー・キュー・リソースの一意の識別子。
• totalResults: boolean
  "?totalResults=true"の場合、リソース・コレクション表現には"推定行数"が含まれます。それ以外の場合、カウントは含まれません。 デフォルト値はfalseです。

ヘッダー・パラメータ

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

この操作にはリクエスト本文がありません。

トップに戻る

応答

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

• application/json

デフォルトのレスポンス

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

ヘッダー

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

本文( )

ルート・スキーマ : queues-overflowQueues

タイプ: object

ソースを表示

• count(required): integer
  現在の範囲で返されたリソース・インスタンスの数。
• hasMore(required): boolean
  サーバーで使用可能なリソースが、レスポンスで返されたサブセットより多いかどうかを示します。 値がtrueの場合、サーバーから取得するリソースがさらにあります。 デフォルト値はfalseです。
• items: array Items
  タイトル: Items

  コレクション内のアイテム。
• limit(required): integer
  サーバーで使用される実際のページング・サイズ。
• links(required): array Links
  タイトル: Links

  リソース・インスタンスに関連付けられたリンク関係。
• offset(required): integer
  現在のページで使用されるオフセット値。
• totalResults: integer
  "?totalResults=true"の場合の推定行数。それ以外の場合、カウントは含まれません。

{
    "required":[
        "count",
        "hasMore",
        "limit",
        "links",
        "offset"
    ],
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "description":"The estimated row count when \"?totalResults=true\", otherwise the count is not included."
        },
        "offset":{
            "type":"integer",
            "description":"The offset value used in the current page."
        },
        "count":{
            "type":"integer",
            "description":"The number of resource instances returned in the current range."
        },
        "hasMore":{
            "type":"boolean",
            "description":"Indicates whether more resources are available on the server than the subset returned in the response. If the value is true, then there are more resources to retrieve from the server. The default value is false."
        },
        "limit":{
            "type":"integer",
            "description":"The actual paging size used by the server."
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "items":{
            "title":"Items",
            "type":"array",
            "description":"The items in the collection.",
            "items":{
                "$ref":"#/components/schemas/queues-overflowQueues-item-response"
            }
        }
    }
}

ネストされたスキーマ : アイテム

タイプ: array

タイトル: Items

コレクション内のアイテム。

ソースを表示

• Array of: object queues-overflowQueues-item-response

{
    "title":"Items",
    "type":"array",
    "description":"The items in the collection.",
    "items":{
        "$ref":"#/components/schemas/queues-overflowQueues-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"
    }
}

ネストされたスキーマ : queues-overflowQueues-item-response

タイプ: object

ソースを表示

• CreatedBy: string
  タイトル: Created By

  読取り専用: true

  最大長: 64

  オーバーフロー・キュー・リソースを作成したユーザー。
• CreationDate: string (date-time)
  タイトル: Creation Date

  読取り専用: true

  オーバーフロー・キュー・リソースが作成された日時。
• DeleteFlag: boolean
  タイトル: Can Delete

  読取り専用: true

  オーバーフロー・キューを削除できるかどうかを示します。
• EnabledFlag: boolean
  タイトル: Enabled

  最大長: 1

  デフォルト値: true

  オーバーフロー・キュー・リソースが有効かどうかを示します。 有効な場合、値はY、それ以外の場合はNです。
• 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

  リソース・インスタンスに関連付けられたリンク関係。
• ObjectId: integer (int64)
  タイトル: Resource Member ID

  キュー・リソースとして追加されたオーバーフロー・キューの一意の識別子。
• ObjectTypeCd: string
  タイトル: Queue ResourceType

  読取り専用: true

  最大長: 30

  デフォルト値: ORA_SVC_OVERFLOW_QUEUE

  キュー・リソースが個人、チームまたはオーバーフロー・キューであるかどうかを示すコード。
• OverflowQueueId: integer (int64)
  タイトル: Overflow Queue ID

  読取り専用: true

  キューに関連付けられたオーバーフロー・キューの一意の識別子。
• OverflowQueueName: string
  タイトル: Overflow Queue Name

  読取り専用: true

  最大長: 400

  オーバーフロー・キューの名前。
• OverflowQueueNumber: string
  タイトル: Overflow Queue Number

  読取り専用: true

  最大長: 30

  キューに関連付けられたオーバーフロー・キューの公開一意識別子。
• OverflowQueueStripeCd: string
  タイトル: Overflow Queue Stripe Code

  読取り専用: true

  最大長: 30

  オーバーフロー・キューのアプリケーション・コンテキストを示すコード。
• Priority: integer
  タイトル: Priority

  オーバーフロー・キュー・リソースの優先度。
• QueueId: integer (int64)
  タイトル: Queue ID

  キューの一意の識別子。
• QueueName: string
  タイトル: Queue Name

  読取り専用: true

  最大長: 400

  このオーバーフロー・キューが関連付けられているキューの名前。
• QueueNumber: string
  タイトル: Queue Number

  読取り専用: true

  最大長: 30

  このオーバーフロー・キューが関連付けられているキューの公開一意識別子。
• QueueResourceId: integer (int64)
  タイトル: Queue Resource ID

  オーバーフロー・キュー・リソースの一意の識別子。
• UpdateFlag: boolean
  タイトル: Can Update

  読取り専用: true

  オーバーフロー・キューを更新できるかどうかを示します。 デフォルト値はtrueです。

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "title":"Last Updated By",
            "maxLength":64,
            "type":"string",
            "description":"The user who last updated the overflow queue resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreationDate":{
            "title":"Creation Date",
            "type":"string",
            "description":"The date and time when the overflow queue resource 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 overflow queue resource.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OverflowQueueStripeCd":{
            "title":"Overflow Queue Stripe Code",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating the application context of the overflow queue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectId":{
            "title":"Resource Member ID",
            "type":"integer",
            "description":"The unique identifier of the overflow queue added as queue resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "Priority":{
            "title":"Priority",
            "type":"integer",
            "description":"The priority of the overflow queue resource.",
            "nullable":false,
            "x-queryable":true
        },
        "QueueId":{
            "title":"Queue ID",
            "type":"integer",
            "description":"The unique identifier of the queue.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "OverflowQueueName":{
            "title":"Overflow Queue Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the overflow queue.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "OverflowQueueNumber":{
            "title":"Overflow Queue Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the overflow queue associated with the queue.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "DeleteFlag":{
            "title":"Can Delete",
            "type":"boolean",
            "description":"Indicates if the overflow queue can be deleted.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "UpdateFlag":{
            "title":"Can Update",
            "type":"boolean",
            "description":"Indicates if the overflow queue can be updated. The default value is true.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":false
        },
        "QueueNumber":{
            "title":"Queue Number",
            "maxLength":30,
            "type":"string",
            "description":"The public unique identifier of the queue to which this overflow queue is associated.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ObjectTypeCd":{
            "title":"Queue ResourceType",
            "maxLength":30,
            "type":"string",
            "description":"The code indicating whether the queue resource is an individual, a team, or an overflow queue.",
            "nullable":false,
            "readOnly":true,
            "default":"ORA_SVC_OVERFLOW_QUEUE",
            "x-queryable":true
        },
        "QueueResourceId":{
            "title":"Queue Resource ID",
            "type":"integer",
            "description":"The unique identifier of the overflow queue resource.",
            "format":"int64",
            "nullable":false,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "OverflowQueueId":{
            "title":"Overflow Queue ID",
            "type":"integer",
            "description":"The unique identifier of the overflow queue associated with the queue.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "EnabledFlag":{
            "title":"Enabled",
            "maxLength":1,
            "type":"boolean",
            "description":"Indicates whether the overflow queue resource is enabled. If enabled, the value is Y, else the value is N.",
            "nullable":false,
            "default":true,
            "x-queryable":true
        },
        "QueueName":{
            "title":"Queue Name",
            "maxLength":400,
            "type":"string",
            "description":"The name of the queue to which this overflow queue is associated.",
            "nullable":true,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateDate":{
            "title":"Last Updated Date",
            "type":"string",
            "description":"The date and time when the overflow queue resource was last updated.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "LastUpdateLogin":{
            "title":"Last Update Login",
            "maxLength":32,
            "type":"string",
            "description":"The application login associated with the user who last updated the overflow queue resource.",
            "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."
        }
    }
}

「トップに戻る」