ProfileApiServiceInterface
in
Table of Contents
Methods
- downloadInfomodel() : array<string|int, mixed>
- Download an infomodel based on the given id
- findInfomodels() : array<string|int, mixed>
- Find infomodels based on the given search criteria
- getInfomodelNamespaces() : array<string|int, mixed>
- Get infomodel namespaces
- uploadInfomodel() : array<string|int, mixed>
- Upload an infomodel
Methods
downloadInfomodel()
Download an infomodel based on the given id
public
downloadInfomodel(int $id[, bool $nodesetXMLOnly = false ][, bool $metadataOnly = false ]) : array<string|int, mixed>
Parameters
- $id : int
-
- The id of the infomodel to download
- $nodesetXMLOnly : bool = false
-
- Whether to download only the nodeset XML
- $metadataOnly : bool = false
-
- Whether to download only the metadata
Return values
array<string|int, mixed> —- The results of the download
findInfomodels()
Find infomodels based on the given search criteria
public
findInfomodels([array<string|int, mixed> $search = ['*'] ][, int $limit = 300 ]) : array<string|int, mixed>
Parameters
- $search : array<string|int, mixed> = ['*']
-
- The search criteria to use
- $limit : int = 300
-
- The maximum number of results to return
Return values
array<string|int, mixed> —- The results of the search
getInfomodelNamespaces()
Get infomodel namespaces
public
getInfomodelNamespaces() : array<string|int, mixed>
Return values
array<string|int, mixed> —- The infomodel namespaces
uploadInfomodel()
Upload an infomodel
public
uploadInfomodel(array<string|int, mixed> $body[, bool $overwrite = false ]) : array<string|int, mixed>
Parameters
- $body : array<string|int, mixed>
-
- The body of the request containing the infomodel data
- $overwrite : bool = false
-
- Whether to overwrite an existing infomodel with the same name
Return values
array<string|int, mixed> —- The response from the upload