Collaboration APIs
Creates an URL related to the task.
| HTTP method | POST |
| URI | https://api.rambase.net/collaboration/tasks/{taskId}/related-urls |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {taskId} |
Unique task identifier
Integer, minimum 100000 |
| Successful HTTP status code | 201 |
| API resource identifier | 6101, 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.
Url
Required/mandatory field
Uniform Resource Locator
Input must match the following regular expression pattern: ^(https?:\/\/)?[a-zA-Z0-9]+(\.[a-zA-Z0-9]+)+(\/.*)?$
>{String}</Url>Name
Name of URL
This field is optional.
>{String}</Name>Url
Required/mandatory field
Uniform Resource Locator
Input must match the following regular expression pattern: ^(https?:\/\/)?[a-zA-Z0-9]+(\.[a-zA-Z0-9]+)+(\/.*)?$
": "{String}",Name
Name of URL
This field is optional.
": "{String}"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. |
| $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.
RelatedUrlId
URL identifier
>{Integer}</RelatedUrlId>Name
Name of URL
>{String}</Name>Url
Uniform Resource Locator
>{String}</Url>CreatedAt
Date and time of creation
>{Datetime}</CreatedAt>UpdatedAt
Date and time of update
>UserId
User identifier
>{Integer}</UserId>FirstName
First name of the user
>{String}</FirstName>Name
Name of the user
>{String}</Name>UserLink
User reference
>{String}</UserLink>UserId
User identifier
>{Integer}</UserId>FirstName
First name of the user
>{String}</FirstName>Name
Name of the user
>{String}</Name>UserLink
User reference
>{String}</UserLink>RelatedUrlId
URL identifier
": "{Integer}",Name
Name of URL
": "{String}",Url
Uniform Resource Locator
": "{String}",CreatedAt
Date and time of creation
": "{Datetime}",UpdatedAt
Date and time of update
": {UserId
User identifier
": "{Integer}",FirstName
First name of the user
": "{String}",Name
Name of the user
": "{String}",UserLink
User reference
": "{String}",UserId
User identifier
": "{Integer}",FirstName
First name of the user
": "{String}",Name
Name of the user
": "{String}",UserLink
User reference
": "{String}"
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 101606 HTTP 404 | Module not found |
| Error 101551 HTTP 404 | Object {0} not found |