A source or endpoint represents a server location where your sites are managed. Users with appropriate access rights can perform administrative activities appropriate for those rights. For a full list of activities and the access rights that are required for performing them, see List of privileges required for Web API operations.
Use the POST method to create a source with the following input:
-
Service Root URI: https://<Server Name>/<IIS Application Name>/sa/v3
-
Resource path: /Companies('CompanyId')/Environments('EnvironmentId')/EndPoints
-
To configure an endpoint source, you must have a SuperAdmin role.
-
The parameters for the service root URI below are provided as an example. The server and domain name you provide depend on your specific environment.
-
To obtain the 'CompanyId' and 'GroupId' values of the parameters for use in the requests below, run the GET requests described in View groups and roles.
-
The 'Company', 'Group', and 'Environment' parameters must be compatible. To view the parameters, see View groups and roles and Configure an environment.
Sample URI for creating an endpoint source
POST
https://WebApiServer1.APIServerDomain.com/webapibe3.0/sa/v3/Companies('dfbbe4ae-bfb2-44a3-9169-cd6f9f6159b7')/Environments('220b72a9-a805-4e54-a343-60ed95d0532b')/EndPoints
Sample JSON request
{
"Type": "SEM",
"Url": "https://SEMWEBSERVER001.ServerDomain.com/webapi3.0/sem/v3",
"Name": "Intergraph Smart Engineering Manager: SEM Test Source",
"Groups": ["ebe4c46a-3fab-4123-8ed9-adc33305f72d", "c3037511-c5e4-4334-b26f-912e6e8a6d62", "bc755e3d-6533-4a74-8688-84b4ce26ccf2"],
"IsActive": true
}