API

Production APIs

PUT production/resources/{productionResourceId}/capacity-setup/{capacityPeriodId}

Updates capacity setup of the production resource

HTTP method PUT
URI https://api.rambase.net/production/resources/{productionResourceId}/capacity-setup/{capacityPeriodId}
Supported formats Xml, Html, Json (ex. $format=json)
- URI parameter {productionResourceId} Production resource identifier
Integer, minimum 100000
- URI parameter {capacityPeriodId} Sequence number of production resource's capacity period
Integer, minimum 1
Successful HTTP status code 200
API resource identifier 3335, 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
<CapacityPeriod
CapacityPeriod

This field is optional.

>
2
     <UtilizationPercent
UtilizationPercent

Resource utilization for capacity period, given in %. Capacity = calendar day hours * utilization.

Minimum value: 0

Maximum value: 100

This field is optional.

>
{Integer}</UtilizationPercent>
3
     <Description
Description

Note to capacity period, free text.

This field is optional.

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

This field is optional.

>
5
          <ProductionWorkingTimeTemplateId
ProductionWorkingTimeTemplateId

Production working time template identification number

Minimum value: 100000

This field is optional.

>
{Integer}</ProductionWorkingTimeTemplateId>
6
     </ProductionWorkingTimeTemplate>
7
     <Validity
Validity

This field is optional.

>
8
          <EffectiveDate
EffectiveDate

Capacity period valid from date.

This field is optional.

>
{Date}</EffectiveDate>
9
          <ExpirationDate
ExpirationDate

Capacity period valid to and including date.

This field is optional.

>
{Date}</ExpirationDate>
10
     </Validity>
11
</CapacityPeriod>
1
{
2
     "capacityPeriod
CapacityPeriod

This field is optional.

":
{
3
          "utilizationPercent
UtilizationPercent

Resource utilization for capacity period, given in %. Capacity = calendar day hours * utilization.

Minimum value: 0

Maximum value: 100

This field is optional.

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

Note to capacity period, free text.

This field is optional.

":
"{String}",
5
          "productionWorkingTimeTemplate
ProductionWorkingTimeTemplate

This field is optional.

":
{
6
               "productionWorkingTimeTemplateId
ProductionWorkingTimeTemplateId

Production working time template identification number

Minimum value: 100000

This field is optional.

":
"{Integer}"
7
          },
8
          "validity
Validity

This field is optional.

":
{
9
               "effectiveDate
EffectiveDate

Capacity period valid from date.

This field is optional.

":
"{Date}",
10
               "expirationDate
ExpirationDate

Capacity period valid to and including date.

This field is optional.

":
"{Date}"
11
          }
12
     }
13
}

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.

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
1

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 101079 HTTP 400 Mismatch in size of revision parameters