機械翻訳について

移動先

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

スラグ別のアイテムのワークフロー情報のリスト

get

/content/management/api/v1.1/items/.by.slug/{slug}/workflows

特定のアイテムのワークフロー情報をスラグ別にリストします。

リクエスト

パス・パラメータ

• slug: string
  最新の管理アイテムのスラグ値。 slug内の特殊文字はすべてエンコードする必要があります。

問合せパラメータ

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

トップに戻る

レスポンス

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

• application/json

200レスポンス

OK。

本文()

ルート・スキーマ : ItemSubResourceListWorkflowInfo

型: object

アイテムSubResource。

ソースを表示

• data(optional): array data
• links(optional): array links
• totalResults(optional): integer(int32)

{
    "type":"object",
    "properties":{
        "totalResults":{
            "type":"integer",
            "format":"int32"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/WorkflowInfo"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"Item SubResource."
}

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

型: array

ソースを表示

• Array of: object WorkflowInfo
  WorkflowInfo.

{
    "type":"array",
    "items":{
        "$ref":"#/definitions/WorkflowInfo"
    }
}

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

型: array

ソースを表示

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

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

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

型: object

WorkflowInfo.

ソースを表示

• id(optional): string
  ワークフローID
• instanceId: string
  ワークフロー・インスタンスID。
• isCompleted(optional): boolean
  ワークフロー・インスタンスがOICで完了したかどうか。
• 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."
        },
        "status":{
            "type":"string",
            "description":"Workflow status."
        },
        "submittedBy":{
            "type":"string",
            "description":"Submitted by user"
        },
        "submittedDate":{
            "description":"Submitted date and time",
            "$ref":"#/definitions/date"
        },
        "isCompleted":{
            "type":"boolean",
            "description":"If workflow instance is completed or not in OIC."
        },
        "links":{
            "type":"array",
            "description":"Links",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    },
    "description":"WorkflowInfo."
}

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

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

不正リクエスト

403レスポンス

禁止。

404レスポンス

見つかりません。

500レスポンス

内部サーバー・エラー

先頭に戻る