Jump to

• Request
• Response

Get Endpoints

get

/omlmod/v1/cognitive-text

Returns all cognitive text endpoints provided by OML Services. Users cannot create new cognitive text endpoints, but may browse and score against endpoints depending on access.

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Cognitive text endpoints.

Body ()

Root Schema : ServiceEndpointCollection

Type: object

Show Source

• items(required): array items
• links(required): array links

{
    "required":[
        "items",
        "links"
    ],
    "properties":{
        "items":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/ServiceEndpoint"
            }
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OMLResourceLink"
            }
        }
    }
}

Nested Schema : items

Type: array

Show Source

• Array of: object ServiceEndpoint

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

Nested Schema : links

Type: array

Show Source

• Array of: object OMLResourceLink

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

Nested Schema : ServiceEndpoint

Type: object

Show Source

• description(required): string
• links(required): array links
• name(required): string

{
    "required":[
        "name",
        "description",
        "links"
    ],
    "properties":{
        "name":{
            "type":"string"
        },
        "description":{
            "type":"string"
        },
        "links":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/OMLResourceLink"
            }
        }
    }
}

Nested Schema : links

Type: array

Show Source

• Array of: object OMLResourceLink

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

Nested Schema : OMLResourceLink

Type: object

Show Source

• href(required): string
• rel(required): string

{
    "required":[
        "href",
        "rel"
    ],
    "properties":{
        "href":{
            "type":"string"
        },
        "rel":{
            "type":"string"
        }
    }
}

401 Response

Unauthorized.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

404 Response

Resource not found.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

500 Response

Unexpected error.

Body ()

Root Schema : Error

Type: object

Show Source

• code(required): string
• message(required): string

{
    "required":[
        "code",
        "message"
    ],
    "properties":{
        "code":{
            "type":"string"
        },
        "message":{
            "type":"string"
        }
    }
}

Back to Top