機械翻訳について

移動先

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

すべてのワークフローのリスト

get

/content/management/api/v1.1/workflows

すべてのワークフローをリストします。

リクエスト

問合せパラメータ

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

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

  デフォルト値: 0
• orderBy(optional): string
  このパラメータは、結果の順序を制御するために使用します。 この問合せパラメータの値は、fieldName:[asc/desc]の形式に従います。「昇順」は昇順オーダー「説明」が降順を表します。デフォルトの順序は「昇順」です。フィールド名に使用できるフィールドはnameおよびupdatedDateのみです。

  デフォルト値: name:asc
• q(optional): string
  このパラメータは、フィールド値に一致する問合せ式条件を受け入れます。 このような問合せ条件の多くは、AND/OR演算子を使用して結合でき、カッコで囲まれています。 問合せ条件の値は、{fieldName} {operator} "{fieldValue}"の形式に従います。このバージョンでサポートされている条件は、???isEnabled eq "true"またはisEnabled eq "false"、あるいは「roleName eq「ビューア、コントリビュータまたはマネージャ」」またはname co "workflowName"(あるいはその両方)、あるいはrepositoryId eq "RepoId"です。 すべてのフィールド名はオプションです。roleNameのデフォルトは、少なくとも特定のロールを持つワークフローをフィルタ処理するroleName eq "viewer"です。nameは、リクエストされているリソースのコンテキストで解釈されます。 たとえば、ワークフローの名前はワークフロー名を意味します。
  例:
  ?q=isEnabled eq "true")

  デフォルト値: roleName eq "viewer"
• totalResults(optional): boolean
  このパラメータは、ブール・フラグを受け入れます。 trueとして指定した場合、返される結果には合計結果数が含まれる必要があります。

  デフォルト値: false

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : ワークフロー

型: object

ワークフロー

ソースを表示

• 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/Workflow"
            }
        },
        "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":"Workflows"
}

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

型: array

集計結果。

ソースを表示

• Array of: object AggregationResult

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

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

型: array

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

ソースを表示

• Array of: object Workflow
  ワークフロー

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

ネストされたスキーマ: 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
        }
    }
}

ネストされたスキーマ : ワークフロー

型: object

ワークフロー

ソースを表示

• applicationName(optional): string
  ワークフローのアプリケーション名。
• createdBy(optional): string
  リポジトリのcreatedByユーザー。
• createdDate(optional): object date
  date
• description(optional): string
  ワークフローの摘要。
• externalId(optional): string
  ソースからの外部ID。 ポスト・リクエストの必須プロパティです。
• id(optional): string
  ワークフローのID。
• isEnabled(optional): boolean
  OCEでワークフローが有効または無効の場合。
• links(optional): array links
  リンク
• name(optional): string
  ワークフローの名前
• properties(optional): object properties
  許可される追加のプロパティ: additionalProperties

  ワークフローのプロパティ。
• repositories(optional): array repositories
  ワークフローの割り当てられたリポジトリ。
• revision(optional): string
  ワークフローのリビジョン。
• roleName(optional): string
  ワークフローのユーザー・ロールの名前。
• roles(optional): array roles
  ワークフローのロール。
• source(optional): string
  ワークフローのソース。 post Requestの必須プロパティです。
• updatedBy(optional): string
  リポジトリのupdatedByユーザー。
• updatedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the Workflow."
        },
        "name":{
            "type":"string",
            "description":"Name of the Workflow."
        },
        "description":{
            "type":"string",
            "description":"Description of the Workflow."
        },
        "applicationName":{
            "type":"string",
            "description":"Application Name of the Workflow."
        },
        "revision":{
            "type":"string",
            "description":"Revision of the Workflow."
        },
        "externalId":{
            "type":"string",
            "description":"External id coming from source. It is a required property in post request."
        },
        "source":{
            "type":"string",
            "description":"Source of the workflow. It is a required property in post Request."
        },
        "isEnabled":{
            "type":"boolean",
            "description":"If workflow is enabled or disabled in OCE."
        },
        "properties":{
            "type":"object",
            "description":"Properties of a workflow.",
            "additionalProperties":{
                "type":"object"
            }
        },
        "repositories":{
            "type":"array",
            "description":"Assigned repositories of a workflow.",
            "items":{
                "$ref":"#/definitions/RepositoryId"
            }
        },
        "roles":{
            "type":"array",
            "description":"Roles of a workflow.",
            "items":{
                "type":"string"
            }
        },
        "roleName":{
            "type":"string",
            "description":"Name of the user's role on the workflow."
        },
        "createdBy":{
            "type":"string",
            "description":"createdBy user of the Repository."
        },
        "createdDate":{
            "description":"date and time Repository createdDate.",
            "$ref":"#/definitions/date"
        },
        "updatedBy":{
            "type":"string",
            "description":"updatedBy user of the Repository."
        },
        "updatedDate":{
            "description":"date and time Repository updatedDate.",
            "$ref":"#/definitions/date"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Workflow"
}

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

型: object

date

ソースを表示

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

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

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

型: array

リンク

ソースを表示

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

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

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

型: object

使用可能なその他のプロパティ

ソースを表示

• object additionalProperties

{
    "type":"object",
    "description":"Properties of a workflow.",
    "additionalProperties":{
        "type":"object"
    }
}

ワークフローのプロパティ。

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

型: array

ワークフローの割り当てられたリポジトリ。

ソースを表示

• Array of: object RepositoryId
  RepositoryId

{
    "type":"array",
    "description":"Assigned repositories of a workflow.",
    "items":{
        "$ref":"#/definitions/RepositoryId"
    }
}

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

型: array

ワークフローのロール。

ソースを表示

• Array of: string

{
    "type":"array",
    "description":"Roles of a workflow.",
    "items":{
        "type":"string"
    }
}

ネストされたスキーマ: 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."
}

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

型: object

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

型: object

RepositoryId

ソースを表示

• id(optional): string
• name(optional): string
  リポジトリの名前。 これは、レスポンスの取得とリクエストのポスト/送信の必須プロパティです。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string"
        },
        "name":{
            "type":"string",
            "description":"Name of the repository. It is a required property in the get response and post/put request."
        }
    },
    "description":"RepositoryId"
}

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

500レスポンス

内部サーバー・エラー

先頭に戻る