機械翻訳について

移動先

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

ワークフローの読取り

get

/content/management/api/v1.1/workflows/{id}

リクエスト

パス・パラメータ

• id: string
  ワークフローのID。

問合せパラメータ

• 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
  これにより、すべての標準フィールドと各ワークフローのすべての追加フィールドが返されます。
  
• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

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

型: 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レスポンス

不正リクエスト

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

先頭に戻る