Information on this page is only applicable to M-Files (server) version 12.0.6783.0 and higher.

Property definition ID by alias

/structure/properties/itemidbyalias

Resolves one or more property definition aliases to their IDs.

POST

Input: string[]
Output: JSON object (see below)

This endpoint accepts an array of strings of property definition aliases to resolve. A sample request body is shown below:

[
	"PropertyAlias1",
	"PropertyAlias2",
	"UnresolvedAlias"
]

This endpoint returns an object with a property for each provided alias with the value being the ID of the property definition in the current vault that has that alias. A sample response body is shown below:

{
	"PropertyAlias1" : 873,
	"PropertyAlias2" : 432,
	"UnresolvedAlias" : -1
}

Aliases that could not be resolved will be returned as -1.

Sub-Resources

Item Description
Property definition ID from alias (single) Allows resolution of a single property definition ID from its alias