Get entities from Vocabularies (vocabulariesGet)
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
$search (optional)
Query Parameter — Search items by search phrases, see [OData Searching](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374633)
$filter (optional)
Query Parameter — Filter items by property values, see [OData Filtering](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374625)
$count (optional)
Query Parameter — Include count of items, see [OData Count](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374632)
$orderby (optional)
Query Parameter — Order items by property values, see [OData Sorting](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374629)
$select (optional)
Query Parameter — Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)
$expand (optional)
Query Parameter — Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)
Return type
Example data
Content-Type: application/json
{
"d" : {
"results" : [ {
"ValueHelps" : {
"results" : [ {
"VocabularyId" : "aeiou",
"Type" : "aeiou",
"PropertyPath" : "aeiou",
"ServiceUrl" : "aeiou",
"Id" : "aeiou"
} ]
},
"Type" : "aeiou",
"Id" : "aeiou",
"Rules" : {
"results" : [ {
"VocabularyId" : "aeiou",
"Description" : "aeiou",
"ResultDataObjectId" : "aeiou",
"Id" : "aeiou",
"ResultAttributes" : {
"results" : [ {
"VocabularyId" : "aeiou",
"Description" : "aeiou",
"DataObjectId" : "aeiou",
"ValueHelpId" : "aeiou",
"ValueHelp" : "",
"Id" : "aeiou",
"BusinessDataType" : "aeiou",
"Name" : "aeiou"
} ]
},
"ResultDataObject" : {
"Status" : "aeiou",
"VocabularyId" : "aeiou",
"Usage" : "aeiou",
"IsCollection" : "aeiou",
"Description" : "aeiou",
"Attributes" : "",
"Id" : "aeiou",
"Associations" : {
"results" : [ {
"VocabularyId" : "aeiou",
"Description" : "aeiou",
"Cardinality" : "aeiou",
"TargetDataObjectId" : "aeiou",
"DataObjectId" : "aeiou",
"TARGETDATAOBJECTID" : "",
"Id" : "aeiou",
"Name" : "aeiou"
} ]
},
"Name" : "aeiou"
},
"Name" : "aeiou"
} ]
},
"DataObjects" : {
"results" : [ "" ]
}
} ]
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Retrieved entities
Wrapper
0
Error
odata.error
Up
get /Vocabularies('{Id}')
Get entity from Vocabularies by key (vocabulariesIdGet)
Path parameters
Id (required)
Path Parameter — Vocabulary ID
Consumes
This API call consumes the following media types via the
Content-Type request header:
Query parameters
$select (optional)
Query Parameter — Select properties to be returned, see [OData Select](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374620)
$expand (optional)
Query Parameter — Expand related entities, see [OData Expand](http://docs.oasis-open.org/odata/odata/v4.0/odata-v4.0-part1-protocol.html#_Toc445374621)
Return type
Example data
Content-Type: application/json
{
"d" : {
"ValueHelps" : {
"results" : [ {
"VocabularyId" : "aeiou",
"Type" : "aeiou",
"PropertyPath" : "aeiou",
"ServiceUrl" : "aeiou",
"Id" : "aeiou"
} ]
},
"Type" : "aeiou",
"Id" : "aeiou",
"Rules" : {
"results" : [ {
"VocabularyId" : "aeiou",
"Description" : "aeiou",
"ResultDataObjectId" : "aeiou",
"Id" : "aeiou",
"ResultAttributes" : {
"results" : [ {
"VocabularyId" : "aeiou",
"Description" : "aeiou",
"DataObjectId" : "aeiou",
"ValueHelpId" : "aeiou",
"ValueHelp" : "",
"Id" : "aeiou",
"BusinessDataType" : "aeiou",
"Name" : "aeiou"
} ]
},
"ResultDataObject" : {
"Status" : "aeiou",
"VocabularyId" : "aeiou",
"Usage" : "aeiou",
"IsCollection" : "aeiou",
"Description" : "aeiou",
"Attributes" : "",
"Id" : "aeiou",
"Associations" : {
"results" : [ {
"VocabularyId" : "aeiou",
"Description" : "aeiou",
"Cardinality" : "aeiou",
"TargetDataObjectId" : "aeiou",
"DataObjectId" : "aeiou",
"TARGETDATAOBJECTID" : "",
"Id" : "aeiou",
"Name" : "aeiou"
} ]
},
"Name" : "aeiou"
},
"Name" : "aeiou"
} ]
},
"DataObjects" : {
"results" : [ "" ]
}
}
}
Produces
This API call produces the following media types according to the request header;
the media type will be conveyed by the
Content-Type response header.
Responses
200
Retrieved entity
Vocabulary
0
Error
odata.error