Jump to

• Request
• Response

Get a Property Type by ID

get

/api/graph/PropertyTypes/{id}

Gets the property type that matches the specified ID.

Request

Path Parameters

• id(required): string
  The property type ID, in id-PropertyName format.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/json

200 Response

Successful operation

Body ()

Root Schema : schema

Match All

Show Source

• object SuccessfulGetOperation
• object type

{
    "allOf":[
        {
            "$ref":"#/components/schemas/SuccessfulGetOperation"
        },
        {
            "type":"object",
            "properties":{
                "total":{
                    "description":"The total number of results regardless of paging",
                    "type":"integer",
                    "example":"1"
                },
                "data":{
                    "type":"array",
                    "items":{
                        "$ref":"#/components/schemas/graphPropertyTypesRead"
                    }
                }
            }
        }
    ]
}

Nested Schema : SuccessfulGetOperation

Type: object

Show Source

• message: string
  The response message.

  Example: Loaded 1 entries
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: true

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"true"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Loaded 1 entries"
        }
    },
    "type":"object"
}

Nested Schema : type

Type: object

Show Source

• data: array data
• total: integer
  The total number of results regardless of paging

  Example: 1

{
    "type":"object",
    "properties":{
        "total":{
            "description":"The total number of results regardless of paging",
            "type":"integer",
            "example":"1"
        },
        "data":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/graphPropertyTypesRead"
            }
        }
    }
}

Nested Schema : data

Type: array

Show Source

• Array of: object graphPropertyTypesRead

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

Nested Schema : graphPropertyTypesRead

Type: object

Show Source

• PropertyID: string
  Property ID

  Example: id-Customer
• PropertyName: string
  Property Name

  Example: Customer
• RenderType: object RenderType
  Render Type
• RenderTypeID: string
  Render Type ID

  Example: 1
• RenderTypeName: string
  Render Type Name

  Example: String

{
    "properties":{
        "PropertyID":{
            "description":"Property ID",
            "type":"string",
            "example":"id-Customer"
        },
        "PropertyName":{
            "description":"Property Name",
            "type":"string",
            "example":"Customer"
        },
        "RenderType":{
            "description":"Render Type",
            "type":"object",
            "example":{
                "id":"1",
                "name":"String"
            }
        },
        "RenderTypeID":{
            "description":"Render Type ID",
            "type":"string",
            "example":"1"
        },
        "RenderTypeName":{
            "description":"Render Type Name",
            "type":"string",
            "example":"String"
        }
    },
    "type":"object"
}

Nested Schema : RenderType

Type: object

Render Type

Example:

{
    "id":"1",
    "name":"String"
}

Default Response

Failed operation

Body ()

Root Schema : schema

Type: object

Show Source

• errors: array errors
  The list of errors reported. Validation errors will be keyed by record field.
• message: string
  The response message.

  Example: Exception thrown
• success: boolean
  Whether the operation was a success (true) or a failure (false).

  Example: false

{
    "properties":{
        "success":{
            "description":"Whether the operation was a success (<b>true</b>) or a failure (<b>false</b>).",
            "type":"boolean",
            "example":"false"
        },
        "message":{
            "description":"The response message.",
            "type":"string",
            "example":"Exception thrown"
        },
        "errors":{
            "description":"The list of errors reported. Validation errors will be keyed by record field.",
            "type":"array",
            "items":{
                "type":"object"
            }
        }
    },
    "type":"object"
}

Nested Schema : errors

Type: array

The list of errors reported. Validation errors will be keyed by record field.

Show Source

• Array of: object items

{
    "description":"The list of errors reported. Validation errors will be keyed by record field.",
    "type":"array",
    "items":{
        "type":"object"
    }
}

Nested Schema : items

Type: object

Back to Top