API

System APIs

PUT system/submodules/{submoduleId}

Updates the given submodule

HTTP method PUT
URI https://api.rambase.net/system/submodules/{submoduleId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {submoduleId} Submodule identifier
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 2391, version 7

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.

Format:
1
<Submodule
Submodule

This field is optional.

>
2
     <Name
Name

Name of the submodule

This field is optional.

>{String}</Name>
3
     <Description
Description

Description of the submodule

This field is optional.

>{String}</Description>
4
     <InternalDescription
InternalDescription

Internal description of the submodule

This field is optional.

>{String}</InternalDescription>
5
     <IsRequiredForSystem
IsRequiredForSystem

True if the submodule is required to run RamBase

This field is optional.

>{Boolean}</IsRequiredForSystem>
6
     <IsRequiredForModule
IsRequiredForModule

True if the submodule is required to run the module

This field is optional.

>{Boolean}</IsRequiredForModule>
7
     <CommercialResponsible
CommercialResponsible

This field is optional.

>
8
          <UserId
UserId

User identifier

This field is optional.

>{Integer}</UserId>
9
     </CommercialResponsible>
10
     <TechnicalResponsible
TechnicalResponsible

This field is optional.

>
11
          <UserId
UserId

User identifier

This field is optional.

>{Integer}</UserId>
12
     </TechnicalResponsible>
13
</Submodule>
1
{
2
     "submodule
Submodule

This field is optional.

": {
3
          "name
Name

Name of the submodule

This field is optional.

": "{String}",
4
          "description
Description

Description of the submodule

This field is optional.

": "{String}",
5
          "internalDescription
InternalDescription

Internal description of the submodule

This field is optional.

": "{String}",
6
          "isRequiredForSystem
IsRequiredForSystem

True if the submodule is required to run RamBase

This field is optional.

": "{Boolean}",
7
          "isRequiredForModule
IsRequiredForModule

True if the submodule is required to run the module

This field is optional.

": "{Boolean}",
8
          "commercialResponsible
CommercialResponsible

This field is optional.

": {
9
               "userId
UserId

User identifier

This field is optional.

": "{Integer}"
10
          },
11
          "technicalResponsible
TechnicalResponsible

This field is optional.

": {
12
               "userId
UserId

User identifier

This field is optional.

": "{Integer}"
13
          }
14
     }
15
}

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.

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. Fields colored in grey is expandable fields.

Please note that some fields may be removed from the response, based on user roles/duties/permissions.

Format:
1
1

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 101079 HTTP 400 Mismatch in size of revision parameters