Create a Property Type
post
/api/graph/PropertyTypes
Creates a new property type.
The minimum required properties in the request body are:
The minimum required properties in the request body are:
- PropertyName
- RenderType
Request
There are no request parameters for this operation.
Supported Media Types
- application/json
Root Schema : schema
Type:
Show Source
object-
PropertyName: string
Property NameExample:
Customer -
RenderType: integer
Render TypeExample:
1
Response
Supported Media Types
- application/json
200 Response
Successful operation
Root Schema : schema
Match All
Show Source
-
object
SuccessfulAddOperation
The response body for a successful add operation.
-
object
type
Nested Schema : SuccessfulAddOperation
Type:
objectThe response body for a successful add operation.
Show Source
-
message: string
The response message.Example:
Added record -
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 paging.Example:
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:
objectRender 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:
arrayThe list of errors reported. Validation errors will be keyed by record field.
Show Source
-
Array of:
object items
An error.
Nested Schema : items
Type:
objectAn error.