機械翻訳について

移動先

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

現在のユーザーに割り当てられているワークフロー・タスクのリスト

get

/content/management/api/v1.1/workflowTasks

現在のユーザーに割り当てられているタスクをリストします。

リクエスト

問合せパラメータ

• fields(optional): string
  このパラメータは、リスト内の各ワークフロー・タスクで返されるフィールドを制御するために使用します。 このパラメータはitemを受け入れ、指定された場合にのみリスト内の各ワークフロー・タスクのアイテム情報を返します。 すべてのフィールド名で大文字と小文字が区別されるため、問合せに適切なフィールド名を指定する必要があります。 各ワークフロー・タスクには、標準フィールド(id、name、assignedTo、dueDate、initiatedBy、「ソース」、workflow、actions)と追加フィールド(item)の両方があります。fieldsが「すべて」 (小文字)として指定されると、すべての標準フィールドおよび追加フィールドが返されます。 標準フィールドは常にレスポンスで返され、除外することはできません。 ユーザーは追加のフィールドのみをフィルタ処理できます。 このパラメータは問合せではオプションであり、結果にはレスポンスの標準フィールドのみが表示されます。 問合せで指定されたフィールド名が正しくないか無効な場合は、エラーがスローされます。
  
  例: ?fields=item
  これにより、すべての標準フィールドが、各ワークフロー・タスクのitem追加フィールドとともに返されます。
  例: ?fields=all
  これにより、すべての標準フィールドと各ワークフローのすべての追加フィールドが返されます。
  
• limit(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果のサイズの制御に使用します。

  デフォルト値: 100
• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby, first, 最後, prev, next
• offset(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果の開始インデックスを制御するために使用します。

  デフォルト値: 0
• orderBy(optional): string
  このパラメータは、結果の順序を制御するために使用します。 この問合せパラメータの値は、fieldName:[asc/desc]の形式に従います。ascは昇順を表し、descは降順を表します。デフォルトの順序はascです。複数のソート順序はセミコロン(;)で区切られます。
  format : orderBy={fieldName1}:{asc/desc};{fieldName2}:{asc/desc}

  デフォルト値: name:asc
• q(optional): string
  このパラメータは、フィールド値に一致する問合せ式条件を受け入れます。 このような問合せ条件の多くは、AND演算子を使用して結合し、カッコでグループ化できます。 問合せ条件の値は、{fieldName} {operator} "{fieldValue}"の形式に従います。「ソース、assignedTo.typeおよびassignedTo.id」は、このバージョンでサポートされているフィールド名です。 フィールド名はオプションです。 条件が指定されていない場合は、ワークフロー・エンジン全体のすべてのタスクがリストされます。
  例:
  ?q=source eq "OIC"
  ?q=source eq "OIC" AND assignedTo.type eq "user" AND assignedTo.id eq "user123"
  ?q=source eq "OIC" AND assignedTo.type eq "role" AND assignedTo.id eq "SGGroup"
• totalResults(optional): boolean
  このパラメータは、ブール・フラグを受け入れます。 trueとして指定した場合、返される結果には合計結果数が含まれる必要があります。

  デフォルト値: false

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : WorkflowTasks

型: object

WorkflowTasks

ソースを表示

• aggregationResults(optional): array aggregationResults
  集計結果。
• count(optional): integer(int32)
  現在のレスポンス内のレコードの合計数
• hasMore(optional): boolean
  フェッチするページがまだあるかどうかを確認します。
• items(optional): array items
  コレクションに含まれる特異なリソース。
• limit(optional): integer(int32)
  サーバーによって使用される実際のページ・サイズ。 これは、クライアントがリクエストするものと同じではない可能性があります。
• links(optional): array links
  リソースのリンク。
• offset(optional): integer(int32)
  特異リソースが返される実際のインデックス。
• pinned(optional): array pinned
  固定品目。 検索リストの上部に固定されたアイテムを表示
• scrollId(optional): string
  scrollId:検索がスクロール検索に解決された場合。
• totalResults(optional): integer(int32)
  クライアント・リクエストを満たすローの総数(ページング・パラメータを除く)

{
    "type":"object",
    "properties":{
        "hasMore":{
            "type":"boolean",
            "description":"Check whether there are more pages to fetch."
        },
        "offset":{
            "type":"integer",
            "format":"int32",
            "description":"The actual index from which the singular resources are returned."
        },
        "count":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of records in the current response."
        },
        "limit":{
            "type":"integer",
            "format":"int32",
            "description":"Actual page size used by the server. This might not be the same as what the client requests."
        },
        "totalResults":{
            "type":"integer",
            "format":"int32",
            "description":"Total number of rows that satisfy the client request (excluding the paging parameters.)"
        },
        "scrollId":{
            "type":"string",
            "description":"scrollId if the search resolved to a scroll search."
        },
        "items":{
            "type":"array",
            "description":"Singular resources contained in the collection.",
            "items":{
                "$ref":"#/definitions/WorkflowTask"
            }
        },
        "aggregationResults":{
            "type":"array",
            "description":"Aggregation results.",
            "items":{
                "$ref":"#/definitions/AggregationResult"
            }
        },
        "links":{
            "type":"array",
            "description":"Links of the resource.",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "pinned":{
            "type":"array",
            "description":"Pinned items. Shows items pinned at the top of search list",
            "items":{
                "type":"string"
            }
        }
    },
    "description":"WorkflowTasks"
}

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

型: array

集計結果。

ソースを表示

• Array of: object AggregationResult

{
    "type":"array",
    "description":"Aggregation results.",
    "items":{
        "$ref":"#/definitions/AggregationResult"
    }
}

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

型: array

コレクションに含まれる特異なリソース。

ソースを表示

• Array of: object WorkflowTask
  WorkflowTask

{
    "type":"array",
    "description":"Singular resources contained in the collection.",
    "items":{
        "$ref":"#/definitions/WorkflowTask"
    }
}

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

型: array

リソースのリンク。

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"Links of the resource.",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: array

固定品目。 検索リストの上部に固定されたアイテムを表示

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Pinned items. Shows items pinned at the top of search list",
    "items":{
        "type":"string"
    }
}

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

型: object

ソースを表示

• name(optional): string
  読取り専用: true

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "readOnly":true
        }
    }
}

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

型: object

WorkflowTask

ソースを表示

• actions(optional): array actions
  ワークフロー・タスクのアクション。
• assignedTo(optional): array assignedTo
  ユーザー/グループに割当済
• dueDate(optional): object date
  date
• id(optional): string
  ワークフロー・タスクのID。
• initiatedBy(optional): string
  ユーザーにより開始されました
• item(optional): object WorkflowTaskItem
  WorkflowTaskItem
• links(optional): array links
  リンク
• name(optional): string
  ワークフロー・タスクの名前。
• source(optional): string
  ワークフローのソース。
• workflow(optional): object WorkflowId
  WorkflowId

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the workflow task."
        },
        "name":{
            "type":"string",
            "description":"name of the workflow task."
        },
        "source":{
            "type":"string",
            "description":"source of the workflow."
        },
        "assignedTo":{
            "type":"array",
            "description":"Assigned to user/group",
            "items":{
                "$ref":"#/definitions/WorkflowTaskAssignedToBean"
            }
        },
        "dueDate":{
            "description":"Due date and time",
            "$ref":"#/definitions/date"
        },
        "initiatedBy":{
            "type":"string",
            "description":"Initiated by user"
        },
        "item":{
            "description":"Item information.",
            "$ref":"#/definitions/WorkflowTaskItem"
        },
        "workflow":{
            "description":"Workflow information.",
            "$ref":"#/definitions/WorkflowId"
        },
        "actions":{
            "type":"array",
            "description":"Actions on the workflow task.",
            "items":{
                "$ref":"#/definitions/WorkflowTaskActions"
            }
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"WorkflowTask"
}

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

型: array

ワークフロー・タスクのアクション。

ソースを表示

• Array of: object WorkflowTaskActions
  WorkflowTaskActions

{
    "type":"array",
    "description":"Actions on the workflow task.",
    "items":{
        "$ref":"#/definitions/WorkflowTaskActions"
    }
}

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

型: array

ユーザー/グループに割当済

ソースを表示

• Array of: object WorkflowTaskAssignedToBean

{
    "type":"array",
    "description":"Assigned to user/group",
    "items":{
        "$ref":"#/definitions/WorkflowTaskAssignedToBean"
    }
}

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

型: object

date

ソースを表示

• timezone(optional): string
• value(optional): string

{
    "type":"object",
    "properties":{
        "value":{
            "type":"string"
        },
        "timezone":{
            "type":"string"
        }
    },
    "description":"date"
}

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

型: object

WorkflowTaskItem

ソースを表示

• advancedVideoInfo(optional): object advancedVideoInfo
  アイテムがvideo-plusかどうか。
• fileGroup(optional): string
  アイテムのfileGroupの名前。
• id(optional): string
  アイテムのId。
• isMaster(optional): boolean
  アイテムがマスターかどうか。
• language(optional): string
  アイテムの言語。
• links(optional): array links
  リンク
• name(optional): string
  アイテムの名前。
• repositoryId(optional): string
  アイテムのリポジトリ。
• type(optional): string
  タイプの名前。
• typeCategory(optional): string
  アイテムのtypeCategoryの名前。
• version(optional): string
  アイテムの現在のバージョン。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"Name of the item."
        },
        "type":{
            "type":"string",
            "description":"Name of the type."
        },
        "typeCategory":{
            "type":"string",
            "description":"Name of the typeCategory of item."
        },
        "fileGroup":{
            "type":"string",
            "description":"Name of the fileGroup of item."
        },
        "repositoryId":{
            "type":"string",
            "description":"Repository of the item."
        },
        "version":{
            "type":"string",
            "description":"The current version of the item."
        },
        "language":{
            "type":"string",
            "description":"Language of the item."
        },
        "isMaster":{
            "type":"boolean",
            "description":"Whether the item is master."
        },
        "advancedVideoInfo":{
            "type":"object",
            "description":"Whether the item is video-plus."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"WorkflowTaskItem"
}

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

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: object

WorkflowId

ソースを表示

• id(optional): string
  ワークフローのID。
• isEnabled(optional): boolean
  OCEでワークフローが有効化または無効化されている場合。これは読取り専用フィールドです。
• name(optional): string
  ワークフローの名前。これは読取り専用フィールドです。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the Workflow."
        },
        "name":{
            "type":"string",
            "description":"Name of the Workflow.This is a read only field."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"If workflow is enabled or disabled in OCE.This is a read only field."
        }
    },
    "description":"WorkflowId"
}

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

型: object

WorkflowTaskActions

ソースを表示

• name(optional): string
  アクションの名前。
• type(optional): string
  アクションのタイプ。

{
    "type":"object",
    "properties":{
        "name":{
            "type":"string",
            "description":"name of the action."
        },
        "type":{
            "type":"string",
            "description":"type of action."
        }
    },
    "description":"WorkflowTaskActions"
}

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

型: object

ソースを表示

• id(optional): string
  割当て先のID。
• type(optional): string
  担当者のタイプ - user/role.

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the assignee."
        },
        "type":{
            "type":"string",
            "description":"Type of the assignee - user/role."
        }
    }
}

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

型: object

アイテムがvideo-plusかどうか。

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

型: array

リンク

ソースを表示

• Array of: object Link
  リソースのリンク。

{
    "type":"array",
    "description":"Links",
    "items":{
        "$ref":"#/definitions/Link"
    }
}

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

型: object

リソースのリンク。

ソースを表示

• href(optional): string
  ターゲット・リソースのURI それはテンプレートURIである可能性があります。 これはレスポンス取得の必須プロパティです。
• mediaType(optional): string
  メディア・タイプ。
• method(optional): string
  ターゲット・リソースへのアクセスに使用できるHTTPメソッド。
• profile(optional): string
  ターゲット・リソースを記述するメタデータにリンクします。
• rel(optional): string
  関連タイプ これはレスポンス取得の必須プロパティです。
• templated(optional): boolean
  URIがテンプレートであるかどうか。

{
    "type":"object",
    "properties":{
        "href":{
            "type":"string",
            "description":"The target resource's URI. It could be template URI. It is a required property in the get response."
        },
        "rel":{
            "type":"string",
            "description":"Relation type. It is a required property in the get response."
        },
        "templated":{
            "type":"boolean",
            "description":"Whether the URI is a template."
        },
        "method":{
            "type":"string",
            "description":"What HTTP method can be used to access the target resource."
        },
        "profile":{
            "type":"string",
            "description":"Link to the metadata that describes the target resource."
        },
        "mediaType":{
            "type":"string",
            "description":"Media type."
        }
    },
    "description":"Link of the resource."
}

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

先頭に戻る