機械翻訳について

移動先

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

すべての登録済ワークフローのロールのリスト

get

/content/management/api/v1.1/workflowRoles

登録済ワークフロー・ロールをリストします。

リクエスト

問合せパラメータ

• limit(optional): integer(int32)
  このパラメータは、負でない整数を受け入れ、結果のサイズの制御に使用します。

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

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

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

  デフォルト値: false

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : WorkflowRoles

型: object

WorkflowRoles

ソースを表示

• applicationName(optional): string
  ワークフローのアプリケーション名。
• createdBy(optional): string
  リポジトリのcreatedByユーザー。
• createdDate(optional): object date
  date
• displayName(optional): string
  ロールの表示名。
• externalRoleId(optional): string
  ソースからの外部ロールID。 これは必須プロパティです。
• id(optional): string
  OCEで生成されたワークフロー・ロールのID。 これは必須プロパティです。
• links(optional): array links
  リンク
• name(optional): string
  ワークフローのロール名。
• source(optional): string
  ソース
• updatedBy(optional): string
  リポジトリのupdatedByユーザー。
• updatedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the Workflow role generated in OCE. It is a required property."
        },
        "source":{
            "type":"string",
            "description":"Source"
        },
        "externalRoleId":{
            "type":"string",
            "description":"External role id coming from source. This is a required property."
        },
        "name":{
            "type":"string",
            "description":"Role name of a Workflow."
        },
        "displayName":{
            "type":"string",
            "description":"Display name of the role."
        },
        "applicationName":{
            "type":"string",
            "description":"Application Name of 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":"WorkflowRoles"
}

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

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

不正リクエスト

500レスポンス

内部サーバー・エラー

先頭に戻る