API

Base APIs

GET base/transmission-types/{transmissionTypeId}

Get transmission type

HTTP method GET
URI https://api.rambase.net/base/transmission-types/{transmissionTypeId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {transmissionTypeId} Transmission log type id
Integer, minimum 100000
Successful HTTP status code 200
API resource identifier 6138, version 10

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
<TransmissionType>
2
     <TransmissionTypeId
TransmissionTypeId

Transmission log type id

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

Status of transmission type

Possible domain values can be found here

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

Date and time of creation

>{Datetime}</CreatedAt>
5
     <Key
Key

Key for transmission type

>{String}</Key>
6
     <Name
Name

Descriptive name of transmission type

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

Name translated to selected language. If no translation exists for the given langauage, english name will show.

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>
8
     <Description
Description

Description for transmission type

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

Description translated to selected language. If no translation exists for the given langauage, English description will show.

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>
10
     <IsImport
IsImport

True if RamBase is the receiver of the transmission.

>{Boolean}</IsImport>
11
     <IsDirect
IsDirect

True if data is being directly transmitted to receiving system.

>{Boolean}</IsDirect>
12
     <ViewPermission>
13
          <PermissionId
PermissionId

Permission identifier

>{Integer}</PermissionId>
14
          <PermissionLink
PermissionLink

Permission reference

>{String}</PermissionLink>
15
     </ViewPermission>
16
     <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

>
17
          <Scope
Scope

Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.

Possible domain values can be found here

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}</Scope>
18
          <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>
19
          <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

>
20
               <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>
21
               <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>
22
          </ChangedBy>
23
          <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>
24
     </Repository>
25
</TransmissionType>
1
{
2
     "transmissionType": {
3
          "transmissionTypeId
TransmissionTypeId

Transmission log type id

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

Status of transmission type

Possible domain values can be found here

": "{Integer}",
5
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
6
          "key
Key

Key for transmission type

": "{String}",
7
          "name
Name

Descriptive name of transmission type

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

Name translated to selected language. If no translation exists for the given langauage, english name will show.

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}",
9
          "description
Description

Description for transmission type

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

Description translated to selected language. If no translation exists for the given langauage, English description will show.

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}",
11
          "isImport
IsImport

True if RamBase is the receiver of the transmission.

": "{Boolean}",
12
          "isDirect
IsDirect

True if data is being directly transmitted to receiving system.

": "{Boolean}",
13
          "viewPermission": {
14
               "permissionId
PermissionId

Permission identifier

": "{Integer}",
15
               "permissionLink
PermissionLink

Permission reference

": "{String}"
16
          },
17
          "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

": {
18
               "scope
Scope

Scope of the object. GLOBAL objects is available in all RamBase systems. LOCAL objects is only available in current RamBase system.

Possible domain values can be found here

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}",
19
               "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}",
20
               "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

": {
21
                    "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}",
22
                    "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}"
23
               },
24
               "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}"
25
          }
26
     }
27
}

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 101814 HTTP 404 Employee not found