API

System APIs

GET system/submodules/{submoduleId}

Submodule details for provided identifier

HTTP method GET
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 2019, version 15

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
1

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.

$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]
$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
$format String, optional Set the format of the response to use for the request. Accepted values are "xml", "html", "jsonstream", "json"
$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.
$select String, optional Use to define the fields to return in the response. Accepts a comma-separated list of field names. See the Expand and select page for more information.
$expand String, optional Use to include output fields that are not returned by default in the response. Accepts a comma-separated list of expandable field names. See the Expand and Select 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
<Submodule>
2
     <SubmoduleId
SubmoduleId

Submodule identifier

>{Integer}</SubmoduleId>
3
     <Status
Status

Status of the submodule

Possible domain values can be found here

>{Integer}</Status>
4
     <Name
Name

Name of the submodule

>{String}</Name>
5
     <TranslatedName
TranslatedName

Translated name of the submodule. The language used is specified either in $lang or by user settings. If translated name doesn't exist in desired language, english will be used.

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedName in your request URI to get this field

>{String}</TranslatedName>
6
     <Description
Description

Description of the submodule

>{String}</Description>
7
     <TranslatedDescription
TranslatedDescription

Translated description of the submodule. The language used is specified either in $lang or by user settings. If translated description doesn't exist in desired language, english will be used.

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedDescription in your request URI to get this field

>{String}</TranslatedDescription>
8
     <InternalDescription
InternalDescription

Internal description of the submodule

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

True if the submodule is required to run RamBase

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

True if the submodule is required to run the module

>{Boolean}</IsRequiredForModule>
11
     <Module>
12
          <ModuleId
ModuleId

Module identifier

>{Integer}</ModuleId>
13
          <Name
Name

Name of the module

This field is greyed out because it is an expandable field. You have to add $expand=Module.Name in your request URI to get this field

>{String}</Name>
14
          <TranslatedName
TranslatedName

Translated name of the module. The language used is specified either in $lang or by user settings. If translated name doesn't exist in desired language, english will be used.

This field is greyed out because it is an expandable field. You have to add $expand=Module.TranslatedName in your request URI to get this field

>{String}</TranslatedName>
15
          <Description
Description

Descrtiption of the module

>{String}</Description>
16
          <TranslatedDescription
TranslatedDescription

Translated description of the module. The language used is specified either in $lang or by user settings. If translated description doesn't exist in desired language, english will be used.

This field is greyed out because it is an expandable field. You have to add $expand=Module.TranslatedDescription in your request URI to get this field

>{String}</TranslatedDescription>
17
          <ModuleLink
ModuleLink

Module reference

>{String}</ModuleLink>
18
     </Module>
19
     <CommercialResponsible>
20
          <UserId
UserId

User identifier

>{Integer}</UserId>
21
          <Name
Name

Name of the user

>{String}</Name>
22
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
23
          <UserLink
UserLink

User reference

>{String}</UserLink>
24
     </CommercialResponsible>
25
     <TechnicalResponsible>
26
          <UserId
UserId

User identifier

>{Integer}</UserId>
27
          <Name
Name

Name of the user

>{String}</Name>
28
          <FirstName
FirstName

First name of the user

>{String}</FirstName>
29
          <UserLink
UserLink

User reference

>{String}</UserLink>
30
     </TechnicalResponsible>
31
     <Repository
Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>
32
          <IsChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{Boolean}</IsChanged>
33
          <ChangedBy
ChangedBy

EmployeeId of the employee making the change

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>
34
               <UserId
UserId

User identifier

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{Integer}</UserId>
35
               <UserLink
UserLink

User reference

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{String}</UserLink>
36
          </ChangedBy>
37
          <IsPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

>{Boolean}</IsPendingDeployment>
38
     </Repository>
39
</Submodule>
1
{
2
     "submodule": {
3
          "submoduleId
SubmoduleId

Submodule identifier

": "{Integer}",
4
          "status
Status

Status of the submodule

Possible domain values can be found here

": "{Integer}",
5
          "name
Name

Name of the submodule

": "{String}",
6
          "translatedName
TranslatedName

Translated name of the submodule. The language used is specified either in $lang or by user settings. If translated name doesn't exist in desired language, english will be used.

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedName in your request URI to get this field

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

Description of the submodule

": "{String}",
8
          "translatedDescription
TranslatedDescription

Translated description of the submodule. The language used is specified either in $lang or by user settings. If translated description doesn't exist in desired language, english will be used.

This field is greyed out because it is an expandable field. You have to add $expand=TranslatedDescription in your request URI to get this field

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

Internal description of the submodule

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

True if the submodule is required to run RamBase

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

True if the submodule is required to run the module

": "{Boolean}",
12
          "module": {
13
               "moduleId
ModuleId

Module identifier

": "{Integer}",
14
               "name
Name

Name of the module

This field is greyed out because it is an expandable field. You have to add $expand=Module.Name in your request URI to get this field

": "{String}",
15
               "translatedName
TranslatedName

Translated name of the module. The language used is specified either in $lang or by user settings. If translated name doesn't exist in desired language, english will be used.

This field is greyed out because it is an expandable field. You have to add $expand=Module.TranslatedName in your request URI to get this field

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

Descrtiption of the module

": "{String}",
17
               "translatedDescription
TranslatedDescription

Translated description of the module. The language used is specified either in $lang or by user settings. If translated description doesn't exist in desired language, english will be used.

This field is greyed out because it is an expandable field. You have to add $expand=Module.TranslatedDescription in your request URI to get this field

": "{String}",
18
               "moduleLink
ModuleLink

Module reference

": "{String}"
19
          },
20
          "commercialResponsible": {
21
               "userId
UserId

User identifier

": "{Integer}",
22
               "name
Name

Name of the user

": "{String}",
23
               "firstName
FirstName

First name of the user

": "{String}",
24
               "userLink
UserLink

User reference

": "{String}"
25
          },
26
          "technicalResponsible": {
27
               "userId
UserId

User identifier

": "{Integer}",
28
               "name
Name

Name of the user

": "{String}",
29
               "firstName
FirstName

First name of the user

": "{String}",
30
               "userLink
UserLink

User reference

": "{String}"
31
          },
32
          "repository
Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": {
33
               "isChanged
IsChanged

Tells whether this object has been changed locally and are ready to be committed to the Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{Boolean}",
34
               "changedBy
ChangedBy

EmployeeId of the employee making the change

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": {
35
                    "userId
UserId

User identifier

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{Integer}",
36
                    "userLink
UserLink

User reference

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{String}"
37
               },
38
               "isPendingDeployment
IsPendingDeployment

Tells whether this object has been changed locally and is ready to be deployed from the Repository

This field is greyed out because it is an expandable field. You have to add $expand=Repository in your request URI to get this field

": "{Boolean}"
39
          }
40
     }
41
}

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