ジャンプ先

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

基準に基づいたリソースの検索

post

/oiri/api/v1/task/resources/{resourcetype}/.search

リクエスト

パス・パラメータ

• resourcetype: string

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

• application/json

リクエスト本文 - application/json ()

ルート・スキーマ: schema

型: object

ソースを表示

• criteria(optional): array criteria
• pagination(optional): object pagination
• returnAttributes(optional): array returnAttributes

{
    "properties":{
        "criteria":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/Criteria"
            }
        },
        "pagination":{
            "required":[
                "offset",
                "limit"
            ],
            "type":"object",
            "properties":{
                "offset":{
                    "type":"string"
                },
                "limit":{
                    "type":"string"
                }
            }
        },
        "returnAttributes":{
            "type":"array",
            "items":{
                "type":"string"
            }
        }
    }
}

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

型: array

ソースを表示

• 配列: object Criteria

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/Criteria"
    }
}

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

型: object

ソースを表示

• limit: string
• offset: string

{
    "required":[
        "offset",
        "limit"
    ],
    "type":"object",
    "properties":{
        "offset":{
            "type":"string"
        },
        "limit":{
            "type":"string"
        }
    }
}

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

型: array

ソースを表示

• 配列: string

{
    "type":"array",
    "items":{
        "type":"string"
    }
}

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

型: object

ソースを表示

• filter(optional): string
• type(optional): string

{
    "properties":{
        "type":{
            "type":"string"
        },
        "filter":{
            "type":"string"
        }
    }
}

先頭に戻る

レスポンス

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

• application/json

200レスポンス

操作の成功

Body ()

ルート・スキーマ: ResourceTypeSearchResponse

型: object

ソースを表示

• count(optional): number
• limit(optional): number
• offset(optional): number
• resource(optional): object resource
• totalCount(optional): number

{
    "properties":{
        "resource":{
            "properties":{
                "type":{
                    "type":"string"
                },
                "results":{
                    "type":"array",
                    "items":{
                        "type":"object",
                        "properties":{
                            "userLogin":{
                                "type":"string"
                            },
                            "displayName":{
                                "type":"string"
                            },
                            "organization":{
                                "type":"string"
                            },
                            "id":{
                                "type":"string"
                            }
                        }
                    }
                }
            },
            "type":"object"
        },
        "totalCount":{
            "type":"number"
        },
        "limit":{
            "type":"number"
        },
        "offset":{
            "type":"number"
        },
        "count":{
            "type":"number"
        }
    }
}

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

型: object

ソースを表示

• results(optional): array results
• type(optional): string

{
    "properties":{
        "type":{
            "type":"string"
        },
        "results":{
            "type":"array",
            "items":{
                "type":"object",
                "properties":{
                    "userLogin":{
                        "type":"string"
                    },
                    "displayName":{
                        "type":"string"
                    },
                    "organization":{
                        "type":"string"
                    },
                    "id":{
                        "type":"string"
                    }
                }
            }
        }
    },
    "type":"object"
}

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

型: array

ソースを表示

• 配列: object items

{
    "type":"array",
    "items":{
        "type":"object",
        "properties":{
            "userLogin":{
                "type":"string"
            },
            "displayName":{
                "type":"string"
            },
            "organization":{
                "type":"string"
            },
            "id":{
                "type":"string"
            }
        }
    }
}

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

型: object

ソースを表示

• displayName(optional): string
• id(optional): string
• organization(optional): string
• userLogin(optional): string

{
    "type":"object",
    "properties":{
        "userLogin":{
            "type":"string"
        },
        "displayName":{
            "type":"string"
        },
        "organization":{
            "type":"string"
        },
        "id":{
            "type":"string"
        }
    }
}

先頭に戻る