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.Example:
id-Customer
There's no request body for this operation.
Back to TopResponse
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulGetOperation
The response body for a successful get operation.
-
object
type
Nested Schema : SuccessfulGetOperation
Type:
object
The response body for a successful get operation.
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
Nested Schema : type
Type:
Show Source
object
-
data: array
data
-
total: integer
The total number of results regardless of pagingExample:
1
Nested Schema : graphPropertyTypesRead
Type:
Show Source
object
-
PropertyID: string
Property IDExample:
id-Customer
-
PropertyName: string
Property NameExample:
Customer
-
RenderType: object
RenderType
Render Type
-
RenderTypeID: string
Render Type IDExample:
1
-
RenderTypeName: string
Render Type NameExample:
String
Nested Schema : RenderType
Type:
object
Render Type
Example:
{
"id":"1",
"name":"String"
}
Default Response
Failed operation
Root Schema : schema
Type:
Show Source
object
-
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
Nested Schema : errors
Type:
array
The list of errors reported. Validation errors will be keyed by record field.
Show Source
-
Array of:
object items
An error.
Nested Schema : items
Type:
object
An error.