- URL:
- https://<root>/services/types/extensions/register
- Methods:
POST- Version Introduced:
- 11.2
Access requirements
Required privileges
The Enterprise Administrator API requires privilege-based access. An administrator must be assigned a specific user privilege, or role, to access any given endpoint. Listed below are the user privileges or roles an administrator can be assigned that provides access to this endpoint. If multiple privileges are listed, only one needs to be assigned to gain access.
Tokens
This API requires token-based authentication. A token is automatically generated for administrators who sign in to the Enterprise Administrator API directory's HTML interface. Tokens generated in this way are stored for the entirety of the session.
Those accessing the API directory outside of the HTML interface will need to acquire a session token from the generate operation in the Enterprise Directory API. For security reasons, all POST requests made to the Enterprise Administrator API must include a token in the request body.
Description
The register operation registers the server object extensions defined in the .soe file. A .soe file is a container of one or more server object extensions.
Before you perform this operation, the .soe file needs to be uploaded to the server. The item returned after uploading the file is used as the value for the id parameter.
Request parameters
| Parameter | Details |
|---|---|
| The uploaded item ID of the Example |
| The response format. The default response format is Values: |
Example usage
The following is a sample POST request for the register operation:
POST /<context>/admin/services/types/extensions/register HTTP/1.1
Host: organization.example.com
Content-Type: application/x-www-form-urlencoded
Content-Length: []
id=i03a2b59db-e60d-48ce-8b0e-2fd3cff73b1a&f=jsonJSON Response example
The following is a sample success response for the register operation, indicating that the .soe file was uploaded successfully:
{
"status": "success"
}