# Properties

# GET GET Query Property Definitions

# /definitions/property

# Description

Retrieves the list of latest property definitions based on version number. You can use the parameters filter, limit, and includeDeleted to refine the list.

# Filterable properties:

definitionId: string

# Parameters

Name	Located in	Description	Required	Schema
limit	query	Limit the number of returned values. Default value is 100.	No	LimitClause
includeDeleted	query	Include property definitions marked as deleted.	No	-
filter	query	A boolean expression used to filter the results	No	WhereClause

# Responses

Code	Description	Schema
200	A list of property definitions	Property Definition
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
429	Too many requests - indicates the user has sent too many requests in a given amount of time	ServiceErrors
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors	ServiceErrors

# POST Create a Property Definition

# /definitions/property

# Description

Adds a new Property definition. It needs to be either a new PropertyDefinitionId or the provided version property needs to conform to the semantic versioning rules for definitions. Otherwise the request will be rejected. Note that there is no update of a definition. If changes need to be made, at least a major version increase is required. Therefore, there is also no PUT operation on this endpoint.

# Payloads

{  
  "propertyDefinitionId": "abb.ability.common.geoLocation",  
  "version": "1.0.0",    
  "dataType": "object",   
  "dataElements": {
      "longitude" : {  
       "dataType": "number"
    },
      "latitude" : {  
       "dataType": "number"
    }
  }  
}

# Responses

Code	Description	Schema
201	Property Definition is Created	Property Definition
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
429	Too many requests - indicates the user has sent too many requests in a given amount of time
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors

# GET GET Retrieve last version of specific Property Definition

# /definitions/property/{propertyDefinitionId}

# Description

Gets latest (based on its version) Property definition based on versions for specific PropertyDefinitionId. Deleted Property definition can also be retrieved by this operation, if the includeDeleted flag is set to true.

# Parameters

Name	Located in	Description	Required	Schema
propertyDefinitioinId	path	propertyDefinitioinId	Yes	string
includeDeleted	boolean	Include property definitions marked as deleted.	No	-

# Responses

Code	Description	Schema
200	Property definition that was found	feedResponseModelDefinition
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
429	Too many requests - indicates the user has sent too many requests in a given amount of time
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors

# DELETE Delete a Property Definition

# /definitions/property/{propertyDefinitionId}

# Description

Marks the Property definition as deleted. No new instances can be created and no new versions added. The Property definition will stay in the database.

# Parameters

Name	Located in	Description	Required	Schema
propertyDefinitioinId	path	propertyDefinitioinId	Yes	string

# Responses

Code	Description	Schema
200	PropertyDefinition marked as deleted	feedResponseModelDefinition
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
429	Too many requests - indicates the user has sent too many requests in a given amount of time
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors

# GET GET Retrieve list of all versions of specific Property Definition

# /definitions/property/{propertyDefinitionId}/versions

# Description

Retrieves a specific PropertyDefinition identified by Property definition id and version. Full version only, e.g.: .../versions/1.0.0

# Parameters

Name	Located in	Description	Required	Schema
propertyDefinitioinId	path	propertyDefinitioinId	Yes	string
includeDeleted	boolean	Whether to included property definitions that have been marked as deleted	No	query
version	String	(partial) version number	Yes	path

# Responses

Code	Description	Schema
200	Property definition that was found.	feedResponseModelDefinition
400	Invalid request. Response will contain details about all encountered validation errors - i.e. request payload too large, malformed JSON, etc	ServiceErrors
401	Not Authorized. Either the Access token is missing or the access token validation failed
403	Access Forbidden. Requesting entity does not have enough permissions to access the resource
429	Too many requests - indicates the user has sent too many requests in a given amount of time
500	Service error. Service has encountered one or more unexpected conditions that prevented it from fulfilling the request, which may or may not be temporary. Response will contain more details about these errors

# Reuse Complex Property Definitions

# Description

In TypeDefinitions and Extensions for properties components, Property Definitions can be reused. Before utilizing in TypeDefinition or Extensions, Property definitions must be created.

# Reuse in TD

{ 
  "model": "abb.test.model", 
  "typeId": "abb.employee.type", 
  "version": "1.0.0", 
  "properties": { 
        "EmpInfo": { 
             "propertyDefinitionId": [ "abb.ability.common.geoLocation@1"] 
         } 
  }
}

# Reuse in extensions

{
    "properties": {
        "propertyDefinitionId": ["abb.ability.common.geoLocation@1"]
    },
    "attributes": {
        "atr1": {
            "dataType": "string",
            "appliesTo": "number"
        }
    }
}

← Variables Models →