機械翻訳について

移動先

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

ワークフローへのアイテムの送信

post

/content/management/api/v1.1/items/{id}/submitToWorkflow

リクエスト

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

• application/json

パス・パラメータ

• id: string
  アイテムのId。

問合せパラメータ

• links(optional): string
  このパラメータは、リンク名のカンマ区切りのリストを受け入れます。 デフォルトでは、このパラメータによって、適用可能なすべてのリンクが指定されます。 可能な値は次のとおりです: self, canonical, describedby

ヘッダー・パラメータ

• X-Requested-With: string
  CSRF攻撃を軽減するためのカスタム・ヘッダー。

  許容値: [ "XMLHttpRequest" ]

本文()

ワークフローのID。

ルート・スキーマ : ItemWorkflowSubmitBean

型: object

ItemWorkflowSubmitBean

ソースを表示

• id(optional): string
  ワークフローのID。
• options(optional): object WorkflowSubmitOptions

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the Workflow."
        },
        "options":{
            "$ref":"#/definitions/WorkflowSubmitOptions"
        }
    },
    "description":"ItemWorkflowSubmitBean"
}

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

型: object

ソースを表示

• includeDependencies(optional): boolean
  対象としないアイテム依存関係

{
    "type":"object",
    "properties":{
        "includeDependencies":{
            "type":"boolean",
            "description":"Item dependencies to be included or not"
        }
    }
}

トップに戻る

レスポンス

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

• application/json

201レスポンス

作成されました。

本文()

ルート・スキーマ : WorkflowItemDetails

型: object

WorkflowItemDetails.

ソースを表示

• id(optional): string
  ワークフローID
• instanceId: string
  ワークフロー・インスタンスID。
• isCompleted(optional): boolean
  ワークフロー・インスタンスがOICで完了したかどうか。
• items(optional): array items
  アイテム詳細。
• links(optional): array links
  リンク
• name(optional): string
  ワークフロー名
• status(optional): string
  ワークフロー・ステータス
• submittedBy(optional): string
  ユーザーにより送信済
• submittedDate(optional): object date
  date

{
    "type":"object",
    "required":[
        "instanceId"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Workflow id."
        },
        "instanceId":{
            "type":"string",
            "description":"Workflow instance id."
        },
        "name":{
            "type":"string",
            "description":"Workflow name."
        },
        "items":{
            "type":"array",
            "description":"Items Details.",
            "items":{
                "$ref":"#/definitions/ItemId"
            }
        },
        "status":{
            "type":"string",
            "description":"Workflow status."
        },
        "submittedBy":{
            "type":"string",
            "description":"Submitted by user"
        },
        "submittedDate":{
            "description":"Submitted date and time",
            "$ref":"#/definitions/date"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        },
        "isCompleted":{
            "type":"boolean",
            "description":"If workflow instance is completed or not in OIC."
        }
    },
    "description":"WorkflowItemDetails."
}

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

型: array

アイテム詳細。

ソースを表示

• Array of: object ItemId

{
    "type":"array",
    "description":"Items Details.",
    "items":{
        "$ref":"#/definitions/ItemId"
    }
}

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

型: array

リンク

ソースを表示

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

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

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

型: object

date

ソースを表示

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

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

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

型: object

ソースを表示

• id(optional): string
  アイテムのId。
• links(optional): array links
  アイテム・リソースのリンク
• name(optional): string
  アイテムの名前。

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "name":{
            "type":"string",
            "description":"name of the item."
        },
        "links":{
            "type":"array",
            "description":"links of the item resource",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

型: array

アイテム・リソースのリンク

ソースを表示

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

{
    "type":"array",
    "description":"links of the item resource",
    "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."
}

400レスポンス

不正リクエスト

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

先頭に戻る