API

Base APIs

POST base/medias

Creates a new media

HTTP method POST
URI https://api.rambase.net/base/medias
Supported formats Xml, Html, Json (ex. $format=json)
Successful HTTP status code 201
API resource identifier 6548, version 9

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
<Media>
2
     <Title
Title

Required/mandatory field

Title of the media

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

Description

This field is optional.

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

Name of artist / potographer

This field is optional.

>{String}</Photographer>
5
     <Type
Type

DOV: IMAGE or VIDEO

Applicable domain values can be found here

This field is optional.

>{String}</Type>
6
     <Folder>
7
          <FolderId
FolderId

Required/mandatory field

Folder reference

Minimum value: 100000

>{Integer}</FolderId>
8
     </Folder>
9
</Media>
1
{
2
     "media": {
3
          "title
Title

Required/mandatory field

Title of the media

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

Description

This field is optional.

": "{String}",
5
          "photographer
Photographer

Name of artist / potographer

This field is optional.

": "{String}",
6
          "type
Type

DOV: IMAGE or VIDEO

Applicable domain values can be found here

This field is optional.

": "{String}",
7
          "folder": {
8
               "folderId
FolderId

Required/mandatory field

Folder reference

Minimum value: 100000

": "{Integer}"
9
          }
10
     }
11
}

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.

Format:
1
<Media>
2
     <MediaId
MediaId

Media identifier

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

Media status

Possible domain values can be found here

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

DOV: IMAGE or VIDEO

Possible domain values can be found here

>{String}</Type>
5
     <Title
Title

Title of the media

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

Description

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

Name of artist / potographer

>{String}</Photographer>
8
     <FileStorageGuid
FileStorageGuid

Guid reference to file service

>{String}</FileStorageGuid>
9
     <ArchivedAt
ArchivedAt

Date and time of creation

>{Datetime}</ArchivedAt>
10
     <CreatedAt
CreatedAt

Date and time of creation

>{Datetime}</CreatedAt>
11
     <CreatedBy
CreatedBy

PID of the creator of the document

>
12
          <UserId
UserId

User identifier

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

User reference

>{String}</UserLink>
14
     </CreatedBy>
15
     <Folder>
16
          <FolderId
FolderId

Folder reference

>{Integer}</FolderId>
17
          <FolderLink
FolderLink

Company folder id

>{String}</FolderLink>
18
          <UserId
UserId

User identifier

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

User reference

>{String}</UserLink>
20
     </Folder>
21
</Media>
1
{
2
     "media": {
3
          "mediaId
MediaId

Media identifier

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

Media status

Possible domain values can be found here

": "{Integer}",
5
          "type
Type

DOV: IMAGE or VIDEO

Possible domain values can be found here

": "{String}",
6
          "title
Title

Title of the media

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

Description

": "{String}",
8
          "photographer
Photographer

Name of artist / potographer

": "{String}",
9
          "fileStorageGuid
FileStorageGuid

Guid reference to file service

": "{String}",
10
          "archivedAt
ArchivedAt

Date and time of creation

": "{Datetime}",
11
          "createdAt
CreatedAt

Date and time of creation

": "{Datetime}",
12
          "createdBy
CreatedBy

PID of the creator of the document

": {
13
               "userId
UserId

User identifier

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

User reference

": "{String}"
15
          },
16
          "folder": {
17
               "folderId
FolderId

Folder reference

": "{Integer}",
18
               "folderLink
FolderLink

Company folder id

": "{String}",
19
               "userId
UserId

User identifier

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

User reference

": "{String}"
21
          }
22
     }
23
}

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: