機械翻訳について

移動先

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

アイテム・ワークフロー・インスタンスの詳細を取得します。

get

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

指定したインスタンスのアイテムのワークフロー詳細を取得

リクエスト

パス・パラメータ

• id: string
  アイテムのId。
• instanceId: string
  ワークフローのインスタンスID。

問合せパラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : ItemWorkflowStatus

型: object

ItemWorkflowStatus

ソースを表示

• activities(optional): array activities
  ワークフロー・プロセス内のアクティビティ。
• id(optional): string
  ワークフローのID。
• instanceId: string
  ワークフロー・インスタンスID。
• isPurged(optional): boolean
  ワークフロー・インスタンスがパージされている場合、またはOIC.Thisに含まれていない場合、読取り専用フィールドです。
• item(optional): object WorkflowStatusItemBean
  WorkflowStatusItemBean
• 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":"id of the workflow."
        },
        "instanceId":{
            "type":"string",
            "description":"Workflow instance id."
        },
        "name":{
            "type":"string",
            "description":"name of the workflow."
        },
        "status":{
            "type":"string",
            "description":"status of the workflow."
        },
        "submittedBy":{
            "type":"string",
            "description":"Submitted by user"
        },
        "submittedDate":{
            "description":"Submitted date and time",
            "$ref":"#/definitions/date"
        },
        "isPurged":{
            "type":"boolean",
            "description":"If workflow instance is purged or not in OIC.This is a read only field."
        },
        "activities":{
            "type":"array",
            "description":"Activities within the workflow process.",
            "items":{
                "$ref":"#/definitions/ProcessActivitiesBean"
            }
        },
        "item":{
            "description":"Item information.",
            "$ref":"#/definitions/WorkflowStatusItemBean"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"ItemWorkflowStatus"
}

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

型: array

ワークフロー・プロセス内のアクティビティ。

ソースを表示

• Array of: object ProcessActivitiesBean

{
    "type":"array",
    "description":"Activities within the workflow process.",
    "items":{
        "$ref":"#/definitions/ProcessActivitiesBean"
    }
}

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

型: object

WorkflowStatusItemBean

ソースを表示

• id(optional): string
  アイテムのId。
• isDependent(optional): boolean
  アイテムが扶養家族かどうか。
• lastUpdatedVersion(optional): string
  アイテムの更新バージョン
• parents(optional): array parents
  親アイテム詳細
• submittedWithDependencies(optional): boolean
  アイテムが依存関係のあるワークフローに送信される場合。
• version(optional): string
  品目バージョン

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"id of the item."
        },
        "submittedWithDependencies":{
            "type":"boolean",
            "description":"If item is submitted to workflow with dependencies."
        },
        "isDependent":{
            "type":"boolean",
            "description":"If item is dependent or not."
        },
        "version":{
            "type":"string",
            "description":"Item version"
        },
        "lastUpdatedVersion":{
            "type":"string",
            "description":"Item updated version"
        },
        "parents":{
            "type":"array",
            "description":"Parent Item details",
            "items":{
                "$ref":"#/definitions/ParentItemBean"
            }
        }
    },
    "description":"WorkflowStatusItemBean"
}

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

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

型: object

ソースを表示

• details(optional): object details
  許可される追加のプロパティ: additionalProperties

  アクティビティ詳細
• id(optional): string
  アクティビティのID
• itemVersion(optional): string
  品目バージョン
• links(optional): array links
  リンク
• name(optional): string
  アクティビティの名前
• outcome(optional): string
  アクティビティの結果
• sourceActivity(optional): string
  ワークフロー内の前のアクティビティID
• targetActivity(optional): string
  ワークフロー内の現在のアクティビティID
• type(optional): string
  アクティビティのタイプです
• updatedDate: string(date-time)
  アクティビティが更新された日付。

{
    "type":"object",
    "required":[
        "updatedDate"
    ],
    "properties":{
        "id":{
            "type":"string",
            "description":"Id of the activity"
        },
        "type":{
            "type":"string",
            "description":"Type of the activity"
        },
        "name":{
            "type":"string",
            "description":"Name of the activity"
        },
        "sourceActivity":{
            "type":"string",
            "description":"Previous activity Id in the workflow"
        },
        "targetActivity":{
            "type":"string",
            "description":"Current activity Id in the workflow"
        },
        "outcome":{
            "type":"string",
            "description":"Outcome of the activity"
        },
        "updatedDate":{
            "type":"string",
            "format":"date-time",
            "description":"Date on which the activity has been updated."
        },
        "details":{
            "type":"object",
            "description":"Activity details",
            "additionalProperties":{
                "type":"object"
            }
        },
        "itemVersion":{
            "type":"string",
            "description":"Item Version"
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

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

型: object

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

ソースを表示

• object additionalProperties

{
    "type":"object",
    "description":"Activity details",
    "additionalProperties":{
        "type":"object"
    }
}

アクティビティ詳細

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

型: array

リンク

ソースを表示

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

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

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

型: object

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

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

型: array

親アイテム詳細

ソースを表示

• Array of: object ParentItemBean

{
    "type":"array",
    "description":"Parent Item details",
    "items":{
        "$ref":"#/definitions/ParentItemBean"
    }
}

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

型: object

ソースを表示

• id(optional): string
  アセットがワークフローに発行される親ID。
• name(optional): string
  アセットがワークフローに発行される親の名前。
• submittedBy(optional): string
  ユーザーにより送信済
• submittedDate(optional): object date
  date

{
    "type":"object",
    "properties":{
        "id":{
            "type":"string",
            "description":"Parent id with which the asset is submitted to workflow."
        },
        "name":{
            "type":"string",
            "description":"Parent name with which the asset is submitted to workflow."
        },
        "submittedBy":{
            "type":"string",
            "description":"Submitted by user"
        },
        "submittedDate":{
            "description":"Submitted date and time",
            "$ref":"#/definitions/date"
        }
    }
}

304 レスポンス

変更されていません。

400レスポンス

不正リクエスト

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

先頭に戻る