Collaboration APIs
Adds new docref to a file object
| HTTP method | POST |
| URI | https://api.rambase.net/collaboration/files/{fileId}/versions/{versionId}/object-references |
| Supported formats | Xml, Html, Json (ex. $format=json) |
| - URI parameter {fileId} |
File identifier
Integer, minimum 100000 |
| - URI parameter {versionId} |
Version of the file
Integer, minimum 100 |
| Successful HTTP status code | 201 |
| API resource identifier | 4221, version 4 |
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.
Database
Company code/database the object belongs to
This field is optional.
>{String}</Database>ObjectId
Required/mandatory field
Identifier of the object
>{Integer}</ObjectId>ObjectType
Required/mandatory field
Type of object
>{String}</ObjectType>ItemId
Item-number of the object
This field is optional.
>{Integer}</ItemId>ItemType
Type of item
This field is optional.
>{String}</ItemType>Database
Company code/database the object belongs to
This field is optional.
": "{String}",ObjectId
Required/mandatory field
Identifier of the object
": "{Integer}",ObjectType
Required/mandatory field
Type of object
": "{String}",ItemId
Item-number of the object
This field is optional.
": "{Integer}",ItemType
Type of item
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.
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 101746 HTTP 404 | Product structure not found. Id: {0} |
| Error 102267 HTTP 404 | Product structure operation not found |
| Error 102188 HTTP 400 | Missing mandatory parameter for goods reception id |
| Error 102189 HTTP 400 | Missing mandatory parameter for goods reception item id |
| Error 107762 HTTP 400 | Only product structures can auto create work orders for sub production |
| Error 107763 HTTP 400 | Only product structures can be set up for line production |
| Error 107764 HTTP 400 | Only product structures can be externally manufactured |
| Error 102112 HTTP 400 | Purchase price can not be set when using price convesrsion by measurement units |
| Error 103478 HTTP 400 | Purchase price is required |
| Error 102109 HTTP 400 | Supplier is required |
| Error 100047 HTTP 404 | Supplier not found |
| Error 101097 HTTP 404 | Given currency {0} mismatch with currencies of supplier {1} |
| Error 103551 HTTP 400 | IsManufacturedInBatches can only be changed on product structures |
| Error 103554 HTTP 400 | AutomaticallyCreateWorkOrdersForSubstructures can only be changed on product structures |
| Error 104253 HTTP 400 | ProduceInMultipleOf can only be changed on product structures. |
| Error 107694 HTTP 400 | Use line production can only be changed on product structeres |
| Error 106999 HTTP 400 | Sub module 'Projectorder' is not activated in this company |
| Error 106436 HTTP 400 | Unit can only be changed when status is equal to draft (status 1) |
| Error 100167 HTTP 404 | Measurement unit not found |
| Error 104486 HTTP 400 | Unit production is only allowed for measurment units (UNI) of type QTY |
| Error 100200 HTTP 404 | Special handling code not found |
| Error 100092 HTTP 404 | Service template not found |
| Error 103020 HTTP 404 | Qcdoc not found |
| Error 101091 HTTP 404 | Contry of origin is not valid: {0} |
| Error 101124 HTTP 400 | Hardware code already exists |
| Error 106437 HTTP 400 | Type can not be changed when status is not equal to draft (status 1) |
| Error 101009 HTTP 400 | The product has a structure. You can only change the product type to a type that can contain a structure. |
| Error 101010 HTTP 400 | The product structure contains operations and can not be changed to become a phantom structure |
| Error 101008 HTTP 400 | Cannot change product type from a physical type to a virtual type |
| Error 101007 HTTP 400 | Cannot change product type from a virtual type to a physical type |
| Error 103021 HTTP 400 | Linkid must be a rental product |
| Error 104760 HTTP 400 | Costing method can't be changed after product has been received |
| Error 104652 HTTP 400 | Both minimum sales price and minimum sales price currency must be given |
| Error 100563 HTTP 400 | Currency {0} is not supported by the system |
| Error 104653 HTTP 400 | Minimum sales price can not be negative |
| Error 106506 HTTP 404 | Image not found |