API

Product APIs

POST product/products?search={search}&searchMode={searchMode}/api-operations/101541/instances

Bulk update products.

This is an API operation. Read the documentation pages for more information about API operations.

HTTP method POST
URI https://api.rambase.net/product/products?search={search}&searchMode={searchMode}/api-operations/101541/instances
Supported formats Xml, Html, Json (ex. $format=json)
Custom fields Custom fields supported
Successful HTTP status code 200
API resource identifier 5518, version 18

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
<Parameters
Parameters

This field is optional.

>
2
     <Filter
Filter

Look up filter to select which products that should be updated.

This field is optional.

>{String}</Filter>
3
     <Product
Product

This field is optional.

>
4
          <CustomField1
CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

This field is optional.

>{String}</CustomField1>
5
          <CustomField2
CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

This field is optional.

>{String}</CustomField2>
6
          <CustomField3
CustomField3

Custom field for grouping, sorting, categorizing and other purposes

This field is optional.

>{String}</CustomField3>
7
          <Weight
Weight

The weight of the product in kilograms.

Minimum value: 0

This field is optional.

>{Decimal}</Weight>
8
          <CountryOfOriginCode
CountryOfOriginCode

Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.

This field is optional.

>{String}</CountryOfOriginCode>
9
          <PublicProductUri
PublicProductUri

Public/external product URI for more information about the product. Will typically be an URL to product details at the manufacturer web site.

Input must match the following regular expression pattern: ^(http|https):\/\/[\w\-_]+(\.[\w\-_]+)+([\w\-\.,@?^=%&:/~\+#]*[\w\-\@?^=%&/~\+#])?$

This field is optional.

>{String}</PublicProductUri>
10
          <RequireSerialNumberBeforeShipping
RequireSerialNumberBeforeShipping

If all units of this product should have a serial number before shipping, you should require serial number to be specified before shipping this product. Shipping includes supplier returns, shipping advices and stock transfers.

This field is optional.

>{Boolean}</RequireSerialNumberBeforeShipping>
11
          <Manufacturer
Manufacturer

Manufacturer of the product

This field is optional.

>
12
               <ManufacturerId
ManufacturerId

Manufacturer identifier

Minimum value: 1000

This field is optional.

>{Integer}</ManufacturerId>
13
          </Manufacturer>
14
          <ProductClassification
ProductClassification

This field is optional.

>
15
               <ProductClassificationId
ProductClassificationId

Product classification identifier

This field is optional.

>{String}</ProductClassificationId>
16
          </ProductClassification>
17
          <Production
Production

This field is optional.

>
18
               <IsTraceableMaterialOfProductUnit
IsTraceableMaterialOfProductUnit

Normally, if a part is defined with more than one piece in a product structure and is included in the trace list, the LCM part list will show a single line with the total quantity (e.g., 2 pcs), unless adjustments are made manually.
With this setting turned ON, however, the part is split into separate lines - one for each piece.

This field is optional.

>{Boolean}</IsTraceableMaterialOfProductUnit>
19
               <RequireSerialNumberWhenTraceableMaterial
RequireSerialNumberWhenTraceableMaterial

During production of a product structure, each produced unit generates a list of tracable materials included in the finished unit. If CheckSerialnoOnParts is true in KITDOC, and this value is true, this product requires a serial number in the tracable materials list before the operation it belongs to can be completed.

This field is optional.

>{Boolean}</RequireSerialNumberWhenTraceableMaterial>
20
               <IsManufacturedInBatches
IsManufacturedInBatches

Products is either manufactured in batch product units, or single product units. When manufactured as single, each production unit of a production work order should result in seperate product units. When manufactured in batches, all production units from one production work order should result in one common product unit.

This field is optional.

>{Boolean}</IsManufacturedInBatches>
21
               <PlanningCategory
PlanningCategory

Planning category

Applicable domain values can be found here

This field is optional.

>{String}</PlanningCategory>
22
               <ManufacturingArea
ManufacturingArea

This field is optional.

>
23
                    <ManufacturingAreaId
ManufacturingAreaId

Manufacturing area identifier

Minimum value: 100000

This field is optional.

>{Integer}</ManufacturingAreaId>
24
               </ManufacturingArea>
25
          </Production>
26
          <Sales
Sales

This field is optional.

>
27
               <MinimumGrossMargin
MinimumGrossMargin

The minimum gross margin, in percent, for the product

Minimum value: 0

This field is optional.

>{Decimal}</MinimumGrossMargin>
28
               <WarrantyPeriod
WarrantyPeriod

The time period (in months) in which the product may be returned or exchanged. The warranty period starts at the date of shipment to customer.

Minimum value: 0

This field is optional.

>{Integer}</WarrantyPeriod>
29
               <StandardLeadTime
StandardLeadTime

The standard lead time, in number of days, from customer places order to delivery.

Minimum value: 0

This field is optional.

>{Integer}</StandardLeadTime>
30
          </Sales>
31
          <Stock
Stock

This field is optional.

>
32
               <RequireSerialNumberAtGoodsReception
RequireSerialNumberAtGoodsReception

If all units of this product should have a serial number in stock, you should require serial number to be required at goods reception. This will ensure that serial number is specified before goods receptions with this product is registered.

This field is optional.

>{Boolean}</RequireSerialNumberAtGoodsReception>
33
          </Stock>
34
          <Procurement
Procurement

This field is optional.

>
35
               <ExpectedLeadTime
ExpectedLeadTime

The expected lead time, in number of days, from ordering from supplier to goods reception. Used in different purchase processes, typically when supplier is unknown. Note that this might differ from the standard lead times defined on the different suppliers.

Minimum value: 0

This field is optional.

>{Integer}</ExpectedLeadTime>
36
          </Procurement>
37
     </Product>
38
     <ProductLocation
ProductLocation

This field is optional.

>
39
          <Location
Location

This field is optional.

>
40
               <LocationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

>{Integer}</LocationId>
41
          </Location>
42
          <Procurement
Procurement

This field is optional.

>
43
               <BlockedForPurchase
BlockedForPurchase

If a product is blocked for purchase, no purchase quotes or purchase orders with that product can be registered.

This field is optional.

>{Boolean}</BlockedForPurchase>
44
               <ExcludeFromSOPProcesses
ExcludeFromSOPProcesses

Exclude product from sales- and operation (SOP) processes for location. Typically used for products/materials being purchased, but can also be set for products with product structure.

This field is optional.

>{Boolean}</ExcludeFromSOPProcesses>
45
               <PurchaseGroup
PurchaseGroup

This field is optional.

>
46
                    <PurchaseGroupId
PurchaseGroupId

Purchase group identifier

This field is optional.

>{Integer}</PurchaseGroupId>
47
               </PurchaseGroup>
48
          </Procurement>
49
          <Stock
Stock

This field is optional.

>
50
               <PreferredStockLocation
PreferredStockLocation

Preferred stock location in this location for this product

This field is optional.

>
51
                    <StockLocationId
StockLocationId

Stock location identifier

Minimum value: 100000

This field is optional.

>{Integer}</StockLocationId>
52
               </PreferredStockLocation>
53
               <WarehouseOperatorsGroup
WarehouseOperatorsGroup

This field is optional.

>
54
                    <WarehouseOperatorsGroupId
WarehouseOperatorsGroupId

Warehouse operators group identifier

Minimum value: 100000

This field is optional.

>{Integer}</WarehouseOperatorsGroupId>
55
               </WarehouseOperatorsGroup>
56
          </Stock>
57
          <Production
Production

This field is optional.

>
58
               <BlockedForProduction
BlockedForProduction

If a product is blocked for production, no production work orders with that product can be registered.

This field is optional.

>{Boolean}</BlockedForProduction>
59
               <AutomaticallyCreateWorkOrdersForSubstructures
AutomaticallyCreateWorkOrdersForSubstructures

True if production work orders should be created for sub structures automatically

This field is optional.

>{Boolean}</AutomaticallyCreateWorkOrdersForSubstructures>
60
               <IsManufacturedExternally
IsManufacturedExternally

True if product structure is manufactured externally, and not by ourself

This field is optional.

>{Boolean}</IsManufacturedExternally>
61
               <UseLineProduction
UseLineProduction

True if this product is planned and manufactured in line production.

This field is optional.

>{Boolean}</UseLineProduction>
62
          </Production>
63
          <Sales
Sales

This field is optional.

>
64
               <BlockedForSale
BlockedForSale

If a product is blocked for sales, no sales quotes, sales order requests, sales order change requests or sales orders with that product can be registered in this location.

This field is optional.

>{Boolean}</BlockedForSale>
65
               <BlockedForShipping
BlockedForShipping

If a product is blocked for shipping, no shipments can be sent to customers from this location.

This field is optional.

>{Boolean}</BlockedForShipping>
66
          </Sales>
67
     </ProductLocation>
68
     <CustomsTariffClassifications
CustomsTariffClassifications

This field is optional.

>
69
          <CustomsTariffClassification
CustomsTariffClassification

This field is optional.

>
70
               <Classification
Classification

Customs tariff classification

Applicable domain values can be found here

This field is optional.

>{String}</Classification>
71
               <CustomsTariff
CustomsTariff

This field is optional.

>
72
                    <CustomsTariffId
CustomsTariffId

Customs tariff identifier

This field is optional.

>{Integer}</CustomsTariffId>
73
               </CustomsTariff>
74
          </CustomsTariffClassification>
75
     </CustomsTariffClassifications>
76
     <ProductsToUpdate
ProductsToUpdate

This field is optional.

>
77
          <Product
Product

This field is optional.

>
78
               <ProductId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

>{Integer}</ProductId>
79
          </Product>
80
     </ProductsToUpdate>
81
</Parameters>
1
{
2
     "parameters
Parameters

This field is optional.

": {
3
          "filter
Filter

Look up filter to select which products that should be updated.

This field is optional.

": "{String}",
4
          "product
Product

This field is optional.

": {
5
               "customField1
CustomField1

Custom field for grouping, sorting, categorizing and other purposes.

This field is optional.

": "{String}",
6
               "customField2
CustomField2

Custom field for grouping, sorting, categorizing and other purposes.

This field is optional.

": "{String}",
7
               "customField3
CustomField3

Custom field for grouping, sorting, categorizing and other purposes

This field is optional.

": "{String}",
8
               "weight
Weight

The weight of the product in kilograms.

Minimum value: 0

This field is optional.

": "{Decimal}",
9
               "countryOfOriginCode
CountryOfOriginCode

Two-character code (ISO 3166) identifying the default country where the product is produced. This value is inherrited from the assigned goods reception(s). If not country of origin is specified for the goods reception(s), country of origin is retrieved from the product. If assigned to multiple goods receptions with different origin, the field will be empty.

This field is optional.

": "{String}",
10
               "publicProductUri
PublicProductUri

Public/external product URI for more information about the product. Will typically be an URL to product details at the manufacturer web site.

Input must match the following regular expression pattern: ^(http|https):\/\/[\w\-_]+(\.[\w\-_]+)+([\w\-\.,@?^=%&:/~\+#]*[\w\-\@?^=%&/~\+#])?$

This field is optional.

": "{String}",
11
               "requireSerialNumberBeforeShipping
RequireSerialNumberBeforeShipping

If all units of this product should have a serial number before shipping, you should require serial number to be specified before shipping this product. Shipping includes supplier returns, shipping advices and stock transfers.

This field is optional.

": "{Boolean}",
12
               "manufacturer
Manufacturer

Manufacturer of the product

This field is optional.

": {
13
                    "manufacturerId
ManufacturerId

Manufacturer identifier

Minimum value: 1000

This field is optional.

": "{Integer}"
14
               },
15
               "productClassification
ProductClassification

This field is optional.

": {
16
                    "productClassificationId
ProductClassificationId

Product classification identifier

This field is optional.

": "{String}"
17
               },
18
               "production
Production

This field is optional.

": {
19
                    "isTraceableMaterialOfProductUnit
IsTraceableMaterialOfProductUnit

Normally, if a part is defined with more than one piece in a product structure and is included in the trace list, the LCM part list will show a single line with the total quantity (e.g., 2 pcs), unless adjustments are made manually.
With this setting turned ON, however, the part is split into separate lines - one for each piece.

This field is optional.

": "{Boolean}",
20
                    "requireSerialNumberWhenTraceableMaterial
RequireSerialNumberWhenTraceableMaterial

During production of a product structure, each produced unit generates a list of tracable materials included in the finished unit. If CheckSerialnoOnParts is true in KITDOC, and this value is true, this product requires a serial number in the tracable materials list before the operation it belongs to can be completed.

This field is optional.

": "{Boolean}",
21
                    "isManufacturedInBatches
IsManufacturedInBatches

Products is either manufactured in batch product units, or single product units. When manufactured as single, each production unit of a production work order should result in seperate product units. When manufactured in batches, all production units from one production work order should result in one common product unit.

This field is optional.

": "{Boolean}",
22
                    "planningCategory
PlanningCategory

Planning category

Applicable domain values can be found here

This field is optional.

": "{String}",
23
                    "manufacturingArea
ManufacturingArea

This field is optional.

": {
24
                         "manufacturingAreaId
ManufacturingAreaId

Manufacturing area identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
25
                    }
26
               },
27
               "sales
Sales

This field is optional.

": {
28
                    "minimumGrossMargin
MinimumGrossMargin

The minimum gross margin, in percent, for the product

Minimum value: 0

This field is optional.

": "{Decimal}",
29
                    "warrantyPeriod
WarrantyPeriod

The time period (in months) in which the product may be returned or exchanged. The warranty period starts at the date of shipment to customer.

Minimum value: 0

This field is optional.

": "{Integer}",
30
                    "standardLeadTime
StandardLeadTime

The standard lead time, in number of days, from customer places order to delivery.

Minimum value: 0

This field is optional.

": "{Integer}"
31
               },
32
               "stock
Stock

This field is optional.

": {
33
                    "requireSerialNumberAtGoodsReception
RequireSerialNumberAtGoodsReception

If all units of this product should have a serial number in stock, you should require serial number to be required at goods reception. This will ensure that serial number is specified before goods receptions with this product is registered.

This field is optional.

": "{Boolean}"
34
               },
35
               "procurement
Procurement

This field is optional.

": {
36
                    "expectedLeadTime
ExpectedLeadTime

The expected lead time, in number of days, from ordering from supplier to goods reception. Used in different purchase processes, typically when supplier is unknown. Note that this might differ from the standard lead times defined on the different suppliers.

Minimum value: 0

This field is optional.

": "{Integer}"
37
               }
38
          },
39
          "productLocation
ProductLocation

This field is optional.

": {
40
               "location
Location

This field is optional.

": {
41
                    "locationId
LocationId

Location identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
42
               },
43
               "procurement
Procurement

This field is optional.

": {
44
                    "blockedForPurchase
BlockedForPurchase

If a product is blocked for purchase, no purchase quotes or purchase orders with that product can be registered.

This field is optional.

": "{Boolean}",
45
                    "excludeFromSOPProcesses
ExcludeFromSOPProcesses

Exclude product from sales- and operation (SOP) processes for location. Typically used for products/materials being purchased, but can also be set for products with product structure.

This field is optional.

": "{Boolean}",
46
                    "purchaseGroup
PurchaseGroup

This field is optional.

": {
47
                         "purchaseGroupId
PurchaseGroupId

Purchase group identifier

This field is optional.

": "{Integer}"
48
                    }
49
               },
50
               "stock
Stock

This field is optional.

": {
51
                    "preferredStockLocation
PreferredStockLocation

Preferred stock location in this location for this product

This field is optional.

": {
52
                         "stockLocationId
StockLocationId

Stock location identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
53
                    },
54
                    "warehouseOperatorsGroup
WarehouseOperatorsGroup

This field is optional.

": {
55
                         "warehouseOperatorsGroupId
WarehouseOperatorsGroupId

Warehouse operators group identifier

Minimum value: 100000

This field is optional.

": "{Integer}"
56
                    }
57
               },
58
               "production
Production

This field is optional.

": {
59
                    "blockedForProduction
BlockedForProduction

If a product is blocked for production, no production work orders with that product can be registered.

This field is optional.

": "{Boolean}",
60
                    "automaticallyCreateWorkOrdersForSubstructures
AutomaticallyCreateWorkOrdersForSubstructures

True if production work orders should be created for sub structures automatically

This field is optional.

": "{Boolean}",
61
                    "isManufacturedExternally
IsManufacturedExternally

True if product structure is manufactured externally, and not by ourself

This field is optional.

": "{Boolean}",
62
                    "useLineProduction
UseLineProduction

True if this product is planned and manufactured in line production.

This field is optional.

": "{Boolean}"
63
               },
64
               "sales
Sales

This field is optional.

": {
65
                    "blockedForSale
BlockedForSale

If a product is blocked for sales, no sales quotes, sales order requests, sales order change requests or sales orders with that product can be registered in this location.

This field is optional.

": "{Boolean}",
66
                    "blockedForShipping
BlockedForShipping

If a product is blocked for shipping, no shipments can be sent to customers from this location.

This field is optional.

": "{Boolean}"
67
               }
68
          },
69
          "customsTariffClassifications
CustomsTariffClassifications

This field is optional.

": [
70
               {
71
                    "classification
Classification

Customs tariff classification

Applicable domain values can be found here

This field is optional.

": "{String}",
72
                    "customsTariff
CustomsTariff

This field is optional.

": {
73
                         "customsTariffId
CustomsTariffId

Customs tariff identifier

This field is optional.

": "{Integer}"
74
                    }
75
               }
76
          ],
77
          "productsToUpdate
ProductsToUpdate

This field is optional.

": [
78
               {
79
                    "productId
ProductId

Product identifier

Minimum value: 10000

This field is optional.

": "{Integer}"
80
               }
81
          ]
82
     }
83
}

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.

search String, optional Keyword to limit result set by searching in product name, product description, customer product name, supplier product name and equivalent product names.
searchMode String, optional Defines how the search query parameter works. Possible values are: DEFAULT which only searches in product name and description, fastest search mode, but does not allow filtering on custom fields. INCLEQV which includes equivalents in the search. SSDEFAULT which only searches in product name and description, slower, but allows filtering on custom fields. SSINCLEQV which includes equivalents in the search.

Default: DEFAULT
$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]
$showCustomFields Boolean, optional Set to "true" to include custom fields. Default value is false.

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
<OperationInstance>
2
     <OperationInstanceId
OperationInstanceId

Operation instance identifier

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

Status of the instance, 2 = started, 7 = error, 9 = finished

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

Date and time the operation instance was created

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

Reference to the creator

>
6
          <UserId
UserId

User identifier

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

User reference

>{String}</UserLink>
8
     </CreatedBy>
9
     <CreatedFor>
10
          <ObjectId
ObjectId

Identifier of the object

>{String}</ObjectId>
11
          <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
12
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
13
          <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
14
          <ItemType
ItemType

Type of item

>{String}</ItemType>
15
          <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
16
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
17
     </CreatedFor>
18
     <ApiOperation>
19
          <ApiOprationId
ApiOprationId

Api operation identifiers

>{Integer}</ApiOprationId>
20
          <ApiOperationLink
ApiOperationLink

Api operation reference

>{String}</ApiOperationLink>
21
     </ApiOperation>
22
     <ObjectReference>
23
          <ObjectId
ObjectId

Identifier of the object

>{String}</ObjectId>
24
          <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
25
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
26
          <ItemId
ItemId

Item-number of the object

>{Integer}</ItemId>
27
          <ItemType
ItemType

Type of item

>{String}</ItemType>
28
          <ItemLink
ItemLink

API reference to the item

>{String}</ItemLink>
29
          <RamBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

>{String}</RamBaseKey>
30
     </ObjectReference>
31
     <Error>
32
          <Message
Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

>{String}</Message>
33
          <TranslatedMessage
TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

>{String}</TranslatedMessage>
34
          <StackTrace
StackTrace

Stack trace for details about the error

>{String}</StackTrace>
35
          <ErrorMessage
ErrorMessage

Contains a reference to the error message, if an error occured

>
36
               <ErrorMessageId
ErrorMessageId

Error message identifier

>{Integer}</ErrorMessageId>
37
               <ErrorMessageLink
ErrorMessageLink

Error message reference

>{String}</ErrorMessageLink>
38
          </ErrorMessage>
39
          <Parameters>
40
               <Parameter>
41
                    <Index
Index

Error Key

>{Integer}</Index>
42
                    <Value
Value

Value of the error parameter

>{String}</Value>
43
               </Parameter>
44
          </Parameters>
45
          <InnerErrors>
46
               <Error>
47
                    <Message
Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

>{String}</Message>
48
                    <TranslatedMessage
TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

>{String}</TranslatedMessage>
49
                    <StackTrace
StackTrace

Stack trace for details about the error

>{String}</StackTrace>
50
                    <ErrorMessage
ErrorMessage

Contains a reference to the error message, if an error occured

>
51
                         <ErrorMessageId
ErrorMessageId

Error message identifier

>{Integer}</ErrorMessageId>
52
                         <ErrorMessageLink
ErrorMessageLink

Error message reference

>{String}</ErrorMessageLink>
53
                    </ErrorMessage>
54
                    <Parameters>
55
                         <Parameter>
56
                              <Index
Index

Error Key

>{Integer}</Index>
57
                              <Value
Value

Value of the error parameter

>{String}</Value>
58
                         </Parameter>
59
                    </Parameters>
60
               </Error>
61
          </InnerErrors>
62
     </Error>
63
     <ResultValues>
64
          <ResultValue>
65
               <Key
Key

Key of the result value

>{String}</Key>
66
               <Value
Value

Value of the result value

>{String}</Value>
67
          </ResultValue>
68
     </ResultValues>
69
     <SystemJob
SystemJob

Contains a reference to the system job, if a system job was started

>
70
          <ObjectId
ObjectId

{OIN.ObjectId}

>{Integer}</ObjectId>
71
          <ObjectType
ObjectType

Type of object

>{String}</ObjectType>
72
          <PercentComplete
PercentComplete

Percent complete

>{Integer}</PercentComplete>
73
          <ObjectLink
ObjectLink

API reference to the object

>{String}</ObjectLink>
74
     </SystemJob>
75
     <OperationInstanceLink
OperationInstanceLink

Operation instance reference

>{String}</OperationInstanceLink>
76
</OperationInstance>
1
{
2
     "operationInstance": {
3
          "operationInstanceId
OperationInstanceId

Operation instance identifier

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

Status of the instance, 2 = started, 7 = error, 9 = finished

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

Date and time the operation instance was created

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

Reference to the creator

": {
7
               "userId
UserId

User identifier

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

User reference

": "{String}"
9
          },
10
          "createdFor": {
11
               "objectId
ObjectId

Identifier of the object

": "{String}",
12
               "objectType
ObjectType

Type of object

": "{String}",
13
               "objectLink
ObjectLink

API reference to the object

": "{String}",
14
               "itemId
ItemId

Item-number of the object

": "{Integer}",
15
               "itemType
ItemType

Type of item

": "{String}",
16
               "itemLink
ItemLink

API reference to the item

": "{String}",
17
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
18
          },
19
          "apiOperation": {
20
               "apiOprationId
ApiOprationId

Api operation identifiers

": "{Integer}",
21
               "apiOperationLink
ApiOperationLink

Api operation reference

": "{String}"
22
          },
23
          "objectReference": {
24
               "objectId
ObjectId

Identifier of the object

": "{String}",
25
               "objectType
ObjectType

Type of object

": "{String}",
26
               "objectLink
ObjectLink

API reference to the object

": "{String}",
27
               "itemId
ItemId

Item-number of the object

": "{Integer}",
28
               "itemType
ItemType

Type of item

": "{String}",
29
               "itemLink
ItemLink

API reference to the item

": "{String}",
30
               "ramBaseKey
RamBaseKey

Internal RamBase identifier of the object/item

": "{String}"
31
          },
32
          "error": {
33
               "message
Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

": "{String}",
34
               "translatedMessage
TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

": "{String}",
35
               "stackTrace
StackTrace

Stack trace for details about the error

": "{String}",
36
               "errorMessage
ErrorMessage

Contains a reference to the error message, if an error occured

": {
37
                    "errorMessageId
ErrorMessageId

Error message identifier

": "{Integer}",
38
                    "errorMessageLink
ErrorMessageLink

Error message reference

": "{String}"
39
               },
40
               "parameters": [
41
                    {
42
                         "index
Index

Error Key

": "{Integer}",
43
                         "value
Value

Value of the error parameter

": "{String}"
44
                    }
45
               ],
46
               "innerErrors": [
47
                    {
48
                         "message
Message

Full error message/description. The message is generated from the specified ErrorMessage object, expanded with the given parameter(s).

": "{String}",
49
                         "translatedMessage
TranslatedMessage

Full translated error description. The language used is specified either in $lang or by user settings. If error message don't exist in desired language, english will be used.

": "{String}",
50
                         "stackTrace
StackTrace

Stack trace for details about the error

": "{String}",
51
                         "errorMessage
ErrorMessage

Contains a reference to the error message, if an error occured

": {
52
                              "errorMessageId
ErrorMessageId

Error message identifier

": "{Integer}",
53
                              "errorMessageLink
ErrorMessageLink

Error message reference

": "{String}"
54
                         },
55
                         "parameters": [
56
                              {
57
                                   "index
Index

Error Key

": "{Integer}",
58
                                   "value
Value

Value of the error parameter

": "{String}"
59
                              }
60
                         ]
61
                    }
62
               ]
63
          },
64
          "resultValues": [
65
               {
66
                    "key
Key

Key of the result value

": "{String}",
67
                    "value
Value

Value of the result value

": "{String}"
68
               }
69
          ],
70
          "systemJob
SystemJob

Contains a reference to the system job, if a system job was started

": {
71
               "objectId
ObjectId

{OIN.ObjectId}

": "{Integer}",
72
               "objectType
ObjectType

Type of object

": "{String}",
73
               "percentComplete
PercentComplete

Percent complete

": "{Integer}",
74
               "objectLink
ObjectLink

API reference to the object

": "{String}"
75
          },
76
          "operationInstanceLink
OperationInstanceLink

Operation instance reference

": "{String}"
77
     }
78
}

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 101346 HTTP 404 Stock location assignment log not found
Error 101420 HTTP 404 Setting definition not found
Error 100199 HTTP 404 Location is not found
Error 108137 HTTP 400 Standard ManhourRate is not set for Resource
Error 102115 HTTP 400 All purchase price conversion fields must be blanked, or all must be filled in
Error 102116 HTTP 400 Selected measurement unit is not activated in your system
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 107276 HTTP 400 Serial number of registered rental unit cannot be modified
Error 109482 HTTP 400 The availability start date for non-owners must not precede the rental unit's availability date
Error 109483 HTTP 400 The end date of availability for non-owners cannot be later than the end date of the rental unit
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 106680 HTTP 400 Not allowed when product is of subscription sales type
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 108988 HTTP 400 Sales type can not be changed when status is equal to completed(status 9)
Error 109184 HTTP 400 Sales type can not be changed to Subscription from other types.
Error 109185 HTTP 400 Sales type can not be changed to other types from Subscription.
Error 109180 HTTP 400 Sales type can not be changed from Rental/Sale to Sales
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