機械翻訳について

移動先

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

動的プロセス・インスタンスのリストを取得

get

/ic/api/process/v1/dp-instances

ユーザーがアクセスできる動的プロセス・インスタンスのリストを取得します。

リクエスト

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

• application/json

問合せパラメータ

• childProcessInstanceId: string
  指定したIDを持つサブプロセス・インスタンスがある1つの動的プロセス・インスタンスに問合せを制限します。
• closedAfter: string
  指定した日付より後にクローズされたインスタンスに制限します。 日付の書式は、yyyy-MM-dd'T'HH:mm:ss.SSSZである必要があります。 たとえば、UTCタイムザーンの2013-01-23T14:42:45.000Z。
• closedBefore: string
  指定した日付より前にクローズされた動的プロセス・インスタンスに制限します。 日付の書式は、yyyy-MM-dd'T'HH:mm:ss.SSSZである必要があります。 たとえば、UTCタイムザーンの2013-01-23T14:42:45.000Z。
• createdAfter: string
  指定した日付より後に作成された動的プロセス・インスタンスに制限します。 日付の書式は、yyyy-MM-dd'T'HH:mm:ss.SSSZである必要があります。 たとえば、UTCタイムゾーンで2013-01-23T14:42:45.000Z。
• createdBefore: string
  指定した日付より前に作成された動的プロセス・インスタンスに制限します。 日付の書式は、yyyy-MM-dd'T'HH:mm:ss.SSSZである必要があります。 たとえば、UTCタイムザーンの2013-01-23T14:42:45.000Z。
• firstResult: integer
  結果のページ番号付け。 返される最初の結果のインデックスを指定します。
• instanceId: string
  動的プロセス・インスタンスIDでフィルタします。
• instanceIdIn: array[string]
  コレクション形式: multi

  配列内の動的プロセス・インスタンスIdでフィルタします。
• maxResults: integer
  結果のページ番号付け。 返す結果の最大数を指定します。 それ以上の結果が残っていない場合は、結果が少なくなります。
• parentProcessInstanceId: string
  問合せを、指定したプロセス・インスタンスのサブプロセス・インスタンスであるすべての動的プロセス・インスタンスに制限します。 動的プロセス・インスタンスIDを指定します。
• processDefinitionId: string
  動的プロセス定義IDによるフィルタリング。 完全一致。
• processDefinitionKey: string
  動的プロセス定義キーによるフィルタリング。 完全一致
• processDefinitionKeyNotIn: array[string]
  コレクション形式: multi

  一連の動的プロセス定義に属するインスタンスを除外します。 プロセス定義キーのカンマ区切りのリストにする必要があります。
• processDefinitionName: string
  インスタンスが実行された動的プロセス定義の名前でフィルタします。
• processDefinitionNameLike: string
  パラメータが部分文字列である動的プロセス定義名でフィルタします。 文字列には、同様の戦略を表すワイルドカード文字'%'を含めることができます。 たとえば、先頭は(string%)、末尾は(%string)または次を含む(%string%)です。
• sortBy: string
  指定した基準で結果をソートします。 有効な値は次のとおりです: instanceId, definitionId, createTime, closeTime, duration. sortOrderパラメータと組み合わせて使用する必要があります。
• sortOrder: string
  結果を指定した順序でソートします。 値は昇順の場合は昇順、降順の場合は降順です。 sortByパラメータと組み合わせて使用する必要があります。
• state: string
  問合せを、指定した状態のすべての動的プロセス・インスタンスに制限します。
• updatedBy: string
  指定されたユーザーによって更新された動的プロセス・インスタンスのみを含めます。

トップに戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

本文()

ルート・スキーマ : ProcessInstances

型: object

すべてに一致

ソースを表示

• object CommonModel
  識別子: links
• object ProcessInstances-allOf[1]

{
    "type":"object",
    "allOf":[
        {
            "$ref":"#/definitions/CommonModel"
        },
        {
            "properties":{
                "items":{
                    "type":"array",
                    "items":{
                        "$ref":"#/definitions/ProcessInstance"
                    }
                }
            }
        }
    ]
}

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

型: object

識別子: links

ソースを表示

• links: array links

{
    "type":"object",
    "discriminator":"links",
    "properties":{
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/definitions/Link"
            }
        }
    }
}

ネストされたスキーマ : ProcessInstances-allOf[1]

型: object

ソースを表示

• items: array items

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

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

型: array

ソースを表示

• Array of: object processInstance

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

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

型: object

ソースを表示

• conversationId: string
• createdBy: string
• createdDate: string
• dueDate: string
• expirationDate: string
• href: string(uri)
• isConversationEnabledFlag: boolean
• isDocsEnabledFlag: boolean
• levels: integer(int32)
• links: array links
• ownedBy: string
• priority: integer(int32)
• processDefId: string
• processDN: string
• processId: string
• processName: string
• processNumber: integer(int32)
• state: string
• title: string

{
    "type":"object",
    "properties":{
        "levels":{
            "type":"integer",
            "format":"int32",
            "xml":{
                "attribute":true
            }
        },
        "links":{
            "type":"array",
            "items":{
                "xml":{
                    "name":"links"
                },
                "$ref":"#/definitions/Link"
            }
        },
        "title":{
            "type":"string"
        },
        "processId":{
            "type":"string"
        },
        "processDefId":{
            "type":"string"
        },
        "processName":{
            "type":"string"
        },
        "priority":{
            "type":"integer",
            "format":"int32"
        },
        "ownedBy":{
            "type":"string",
            "xml":{
                "name":"owner"
            }
        },
        "createdBy":{
            "type":"string",
            "xml":{
                "name":"creator"
            }
        },
        "conversationId":{
            "type":"string"
        },
        "state":{
            "type":"string"
        },
        "createdDate":{
            "type":"string"
        },
        "expirationDate":{
            "type":"string"
        },
        "dueDate":{
            "type":"string"
        },
        "processDN":{
            "type":"string"
        },
        "processNumber":{
            "type":"integer",
            "format":"int32"
        },
        "href":{
            "type":"string",
            "format":"uri"
        },
        "isDocsEnabledFlag":{
            "type":"boolean"
        },
        "isConversationEnabledFlag":{
            "type":"boolean"
        }
    },
    "xml":{
        "name":"processInstance",
        "namespace":"http://xmlns.oracle.com/bpm/rest/processdef"
    }
}

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

型: array

ソースを表示

• Array of: object Link

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

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

型: object

ソースを表示

• href: string
• mediaType: string
• rel: string

{
    "type":"object",
    "properties":{
        "rel":{
            "type":"string"
        },
        "href":{
            "type":"string"
        },
        "mediaType":{
            "type":"string"
        }
    }
}

400レスポンス

一部の問合せパラメータが有効でない場合に返されます。 たとえば、sortOrderパラメータが指定されていて、sortByが指定されていない場合などです。

401レスポンス

未認可

500レスポンス

内部サーバー・エラー

先頭に戻る