System APIs
Create a new submodule
| HTTP method | POST |
| URI | https://api.rambase.net/system/submodules |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| Successful HTTP status code | 201 |
| API resource identifier | 2386, version 3 |
The following body must be added to the request. Mouse over fieldnames for description and other useful information about the fields. Note that fields in bold are required/mandatory.
Name
Required/mandatory field
Name of the submodule
>{String}</Name>ModuleId
Required/mandatory field
Module identifier
>{Integer}</ModuleId>Name
Required/mandatory field
Name of the submodule
": "{String}",ModuleId
Required/mandatory field
Module identifier
": "{Integer}"The query string is placed after the resource URL, seperated with a questionmark (?). The query string is composed of a series of query parameters with values. See the page about query parameters on how to use these parameters.
| $access_token String, optional | After successful login you get an access token which needs to be provided in all API requests. Even though it is possible to pass this token as query parameter, we recommended passing it using the HTTP request header as described in Authorization. Note that all access tokens have an expiration time. |
| $db String, optional | Set the database/company for the request |
| $useMinimumVersion Integer, optional | Used to run a new version of an API resource when your API client is running a deprecated API resource. See the Breaking changes page for more information. |
| $showDomainDescriptions Boolean, optional | Set to "true" to include domain descriptions for fields using domain values. See the Domain values page for more information. Default value is false. |
| $lang String, optional | Specifies the language used in the response, following the 3-letter ISO-639-1 [lll] |
Read more about filters and sorting on how to use filter parameters and named filters.
Read more about filters and sorting on how to use sortable parameters
Requesting this resource will yield the following response. Mouse over fieldnames (or fieldgroups) for descriptions and other useful information about the fields.
Please note that some fields may be removed from the response, based on user roles/duties/permissions.
SubmoduleId
Submodule identifier
>{Integer}</SubmoduleId>Name
Name of the submodule
>{String}</Name>Description
Description of the submodule
>{String}</Description>InternalDescription
Internal description of the submodule
>{String}</InternalDescription>IsRequiredForSystem
True if the submodule is required to run RamBase
>{Boolean}</IsRequiredForSystem>IsRequiredForModule
True if the submodule is required to run the module
>{Boolean}</IsRequiredForModule>ModuleId
Module identifier
>{Integer}</ModuleId>Description
Descrtiption of the module
>{String}</Description>ModuleLink
Module reference
>{String}</ModuleLink>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>UserId
User identifier
>{Integer}</UserId>Name
Name of the user
>{String}</Name>FirstName
First name of the user
>{String}</FirstName>UserLink
User reference
>{String}</UserLink>IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
>{Boolean}</IsChanged>ChangedBy
EmployeeId of the employee making the change
>UserId
User identifier
>{Integer}</UserId>UserLink
User reference
>{String}</UserLink>IsPendingDeployment
Tells whether this object has been changed locally and is ready to be deployed from the Repository
>{Boolean}</IsPendingDeployment>SubmoduleId
Submodule identifier
": "{Integer}",Status
Status of the submodule
Possible domain values can be found here
": "{Integer}",Name
Name of the submodule
": "{String}",Description
Description of the submodule
": "{String}",InternalDescription
Internal description of the submodule
": "{String}",IsRequiredForSystem
True if the submodule is required to run RamBase
": "{Boolean}",IsRequiredForModule
True if the submodule is required to run the module
": "{Boolean}",ModuleId
Module identifier
": "{Integer}",Description
Descrtiption of the module
": "{String}",ModuleLink
Module reference
": "{String}"UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}"UserId
User identifier
": "{Integer}",Name
Name of the user
": "{String}",FirstName
First name of the user
": "{String}",UserLink
User reference
": "{String}",IsChanged
Tells whether this object has been changed locally and are ready to be committed to the Repository
": "{Boolean}",ChangedBy
EmployeeId of the employee making the change
": {UserId
User identifier
": "{Integer}",UserLink
User reference
": "{String}"IsPendingDeployment
Tells whether this object has been changed locally and is ready to be deployed from the Repository
": "{Boolean}"
List of available operations/actions for this resource.
See the operations documentation for more information about API operations.
Possible error codes the response might return:
| Error 101013 HTTP 404 | Sub-module not found |
| Error 101079 HTTP 400 | Mismatch in size of revision parameters |