Commit 1cbc09f4: Merged PR 72599: Implement GET Boards / Edges

IMaterialsService.cs

-1+14

/Client/HomagGroup.DigitalFactory.ApiGateway.Client/Interfaces/IMaterialsService.cs

View

using System.Collections.Generic;

using System.Threading.Tasks;

namespace HomagGroup.DigitalFactory.ApiGateway.Client.Interfaces

public interface IMaterialsService

{

/// <summary>

/// Get all the board type data, optionally include board instance data

/// </summary>

/// <returns></returns>

Task<GetBoardsResult> MMGetBoardTypes(bool withInstances = false);

/// <summary>

/// Get all the edgeband type data, optionally include edgeband instance data

/// </summary>

/// <returns></returns>

Task<GetEdgesResult> MMGetEdgebandTypes(bool withInstances = false);

/// <summary>

/// Import material storage data

/// </summary>

/// <returns></returns>

Task<ImportResult> ImportInventory(ImportInventoryRequest data);

Task<ImportResult> ImportInventory(ImportInventoryRequest importInventoryRequest);

}

MaterialsService.cs

-3+31

/Client/HomagGroup.DigitalFactory.ApiGateway.Client/Services/MaterialsService.cs

View

/// </summary>

public MaterialsService(HttpClient client) : base(client) { }

/// <summary>

/// Import material storage data

/// </summary>

/// <inheritdoc />

public async Task<GetBoardsResult> MMGetBoardTypes(bool withInstances = false)

{

var request = new HttpRequestMessage { Method = HttpMethod.Get };

var uri = $"{Prefix}materials/boards?withInstances={withInstances}";

request.RequestUri = new Uri(uri, UriKind.Relative);

request.Headers.AcceptLanguage.Clear();

request.Headers.AcceptLanguage.Add(new StringWithQualityHeaderValue(CultureInfo.CurrentUICulture.Name));

var response = await Client.SendAsync(request).ConfigureAwait(false);

response.HandleDeprecatedMessages(request, ApiVersion, ThrowExceptionOnDeprecatedCalls, OnDeprecatedAction);

response.EnsureSuccessStatusCodeWithDetails(request);

var content = await response.Content.ReadAsStringAsync().ConfigureAwait(false);

return JsonConvert.DeserializeObject<GetBoardsResult>(content, SerializerSettings.Default);

}

/// <inheritdoc />

public async Task<GetEdgesResult> MMGetEdgebandTypes(bool withInstances = false)

{

var request = new HttpRequestMessage { Method = HttpMethod.Get };

var uri = $"{Prefix}materials/edges?withInstances={withInstances}";

request.RequestUri = new Uri(uri, UriKind.Relative);

request.Headers.AcceptLanguage.Clear();

request.Headers.AcceptLanguage.Add(new StringWithQualityHeaderValue(CultureInfo.CurrentUICulture.Name));

var response = await Client.SendAsync(request).ConfigureAwait(false);

response.HandleDeprecatedMessages(request, ApiVersion, ThrowExceptionOnDeprecatedCalls, OnDeprecatedAction);

response.EnsureSuccessStatusCodeWithDetails(request);

var content = await response.Content.ReadAsStringAsync().ConfigureAwait(false);

return JsonConvert.DeserializeObject<GetEdgesResult>(content, SerializerSettings.Default);

}

/// <inheritdoc />

public async Task<ImportResult> ImportInventory(ImportInventoryRequest importInventoryRequest)

{

if (importInventoryRequest == null)

README.md

-249+253

/Documentation/README.md

View

Displayed content is truncated due to maximum viewable content limit.

## Version history

Version | Date | Comment

--------|----------|---------

0.9 |21.01.2021| First Draft

1.0 |26.01.2021| Added IDGetMachines and IDGetParameters Route for ID/PMImport/GetImportState changed

1.1 |29.01.2021| Updated import specification

1.1a |04.02.2021| Import specification updated to v2.2

1.2 |23.03.2021| Added "materialCode" to board results

1.3 |25.03.2021| Optionally you can pass ´machineId´ and ´parameterId´ in the ´IDImport´ method

1.4 |31.03.2021| Added OptimizationStart / GetOptimizationStatus

1.5 |12.04.2021| Added GetOptimizationSolutions / IDGetOptimizationSolutionData

1.6 |14.04.2021| Corrected route for IDStartOptimization / GetOptimizationStatus / GetOptimizationSolutions / IDGetOptimizationSolutionData

1.7 |26.07.2021| Added board and edgeband instance data

1.7.1 |19.08.2021| Added validation errors when starting ID optimization

1.8 |12.10.2021| Added GetTokenInformation / added action groups

1.9 |09.02.2022| Added PMGetImportTemplates / PMImportViaTemplate

1.10 |10.03.2022| Added PMGetFeedbackWorkplaces / PMWorkplaceFeedback

1.11 |07.04.2022| Added new image sizes from MaterialManager

1.12 |31.08.2022| Added IDGetTemplates / IDImportViaTemplate

1.13 |02.09.2022| Updated IDImportViaTemplate

1.14 |12.10.2022| Added IDSendToPA

1.15 |17.10.2022| Update IDGetOptimizationState

1.16 |11.11.2022| Update IDGetTemplates

1.17 |02.12.2022| Adding link to ImportSpecification.md

1.18 |09.12.2022| Added IProductionOrderService

| Version | Date | Comment |

| ------- | ---------- | -------------------------------------------------------------------------------------------------------------------------- |

| 0.9 | 21.01.2021 | First Draft |

| 1.0 | 26.01.2021 | Added IDGetMachines and IDGetParameters Route for ID/PMImport/GetImportState changed |

| 1.1 | 29.01.2021 | Updated import specification |

| 1.1a | 04.02.2021 | Import specification updated to v2.2 |

| 1.2 | 23.03.2021 | Added "materialCode" to board results |

| 1.3 | 25.03.2021 | Optionally you can pass ´machineId´ and ´parameterId´ in the ´IDImport´ method |

| 1.4 | 31.03.2021 | Added OptimizationStart / GetOptimizationStatus |

| 1.5 | 12.04.2021 | Added GetOptimizationSolutions / IDGetOptimizationSolutionData |

| 1.6 | 14.04.2021 | Corrected route for IDStartOptimization / GetOptimizationStatus / GetOptimizationSolutions / IDGetOptimizationSolutionData |

| 1.7 | 26.07.2021 | Added board and edgeband instance data |

| 1.7.1 | 19.08.2021 | Added validation errors when starting ID optimization |

| 1.8 | 12.10.2021 | Added GetTokenInformation / added action groups |

| 1.9 | 09.02.2022 | Added PMGetImportTemplates / PMImportViaTemplate |

| 1.10 | 10.03.2022 | Added PMGetFeedbackWorkplaces / PMWorkplaceFeedback |

| 1.11 | 07.04.2022 | Added new image sizes from MaterialManager |

| 1.12 | 31.08.2022 | Added IDGetTemplates / IDImportViaTemplate |

| 1.13 | 02.09.2022 | Updated IDImportViaTemplate |

| 1.14 | 12.10.2022 | Added IDSendToPA |

| 1.15 | 17.10.2022 | Update IDGetOptimizationState |

| 1.16 | 11.11.2022 | Update IDGetTemplates |

| 1.17 | 02.12.2022 | Adding link to ImportSpecification.md |

| 1.18 | 09.12.2022 | Added IProductionOrderService |

| 2.0.19 | 08.01.2024 | Added GET Boards and GET Edges |

## Introduction

### Terms

Term | Description

--------------------------|--------------------------------------------------------------------------

API gateway | A central gateway for communicating with HOMAG applications. It is deployed worldwide on different regions. The call will automatically be routed to the nearest endpoint / region.

SAT | Subscription Access Token (similar to a PAT (Personal Access Token)). It can be created in the tapio admin UI by the customer; also it can be revoked if needed. This SAT must be created by the end customer and stored inside the partners application for this customer. It is then passed to the API gateway to authenticate the access. In tapio this is also called `Authorization key`.

PartnerApplicationFeature | For each HOMAG feature (like "Import into intelliDivide" or "Import into productionManager" or "Machine Feedback") a special "PartnerApplicationFeature" must be created for each partner and feature. This "PartnerApplicationFeature" must then be bought by the end customer. This will then get assigned to the customers tapio subscription. The customer must then create the SAT for this "PartnerApplicationFeature" and copy the generated string into the partners application for this specific HOMAG feature.

HOMAG partner id | Each partner is assigned a unique partner id. This id must be passed in each call to the API gateway. It is mainly used to identify the calling application (it is more an information). The authentication is still done with the SAT.

| Term | Description |

| ------------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| API gateway | A central gateway for communicating with HOMAG applications. It is deployed worldwide on different regions. The call will automatically be routed to the nearest endpoint / region. |

| SAT | Subscription Access Token (similar to a PAT (Personal Access Token)). It can be created in the tapio admin UI by the customer; also it can be revoked if needed. This SAT must be created by the end customer and stored inside the partners application for this customer. It is then passed to the API gateway to authenticate the access. In tapio this is also called `Authorization key`. |

| PartnerApplicationFeature | For each HOMAG feature (like "Import into intelliDivide" or "Import into productionManager" or "Machine Feedback") a special "PartnerApplicationFeature" must be created for each partner and feature. This "PartnerApplicationFeature" must then be bought by the end customer. This will then get assigned to the customers tapio subscription. The customer must then create the SAT for this "PartnerApplicationFeature" and copy the generated string into the partners application for this specific HOMAG feature. |

| HOMAG partner id | Each partner is assigned a unique partner id. This id must be passed in each call to the API gateway. It is mainly used to identify the calling application (it is more an information). The authentication is still done with the SAT. |

### Partner / developer experience

We support the following headers for tracing:

* `traceparent`

* `tracestate`

- `traceparent`

- `tracestate`

For more information, please refer to the [W3C Trace Context - Level 1 specification](https://www.w3.org/TR/trace-context/).

#### Host

* Production system = `https://api-gateway.homag.cloud`

* Test system = `https://api-gateway-preview.homag.cloud`

- Production system = `https://api-gateway.homag.cloud`

- Test system = `https://api-gateway-preview.homag.cloud`

#### Path prefix

If an error occur, we normally return the problem details as a json object in the response. This is done for all HTTP status codes >= 400.

The main properties are:

* title: A human readable title

* detail: An explanation of the error

* operationId: An reference to our internal logging system, so we can also find the corresponding request in order to dig down the problem

- title: A human readable title

- detail: An explanation of the error

- operationId: An reference to our internal logging system, so we can also find the corresponding request in order to dig down the problem

For more information, please refer to [RFC7807](https://tools.ietf.org/html/rfc7807).

##### Common interface

Name | Method | API | Usage | Action group

--------------------|--------|------------------------------------|-----------------------------------------------------------------------|--------------

GetTokenInformation | POST | `_PREFIX_/common/tokenInformation` | Returns general information about the token and possible action groups|-

| ------------------- | ------ | ---------------------------------- | ---------------------------------------------------------------------- | ------------ |

###### Description of action groups

Here is a list of all available action groups

Action group | Description

--------------------------|-------------------------------------------------------------------------------

CuttingOptimizationImport | Import into intelliDivide cutting (regardless of the license)

NestingOptimizationImport | Import into intelliDivide nesting (regardless of the license)

CuttingOptimization | Start and download of an optimization for cutting (regardless of the license)

NestingOptimization | Start and download of an optimization for nesting (regardless of the license)

ProductionImport | Import into productionManager (regardless of the license)

QueryMaterials | Query materials

MaterialStorageImport | Import materials into the materialManager

| Action group | Description |

| ------------------------- | ----------------------------------------------------------------------------- |

| CuttingOptimizationImport | Import into intelliDivide cutting (regardless of the license) |

| NestingOptimizationImport | Import into intelliDivide nesting (regardless of the license) |

| CuttingOptimization | Start and download of an optimization for cutting (regardless of the license) |

| NestingOptimization | Start and download of an optimization for nesting (regardless of the license) |

| ProductionImport | Import into productionManager (regardless of the license) |

| QueryMaterials | Query materials |

| MaterialStorageImport | Import materials into the materialManager |

##### intelliDivide interface

Name | Method | API | Usage | Action group

------------------------------|--------|---------------------------------------------------------------------------------------------------------------------------------|-------|--------------

IDImport | POST | `_PREFIX_/optimizations/`⤶ `import?machineId={machineId}`⤶ `&parameterId={parameterId}` | Uploads a ZIP-compressed order and optionally pass a machineId and parameterId If the id is also provided in the ZIP file, we will overwrite these settings with the id provided in the url. | CuttingOptimizationImport / NestingOptimizationImport

IDGetImportState | GET | `_PREFIX_/optimizations/`⤶ `import/states/{correlationId}` | Return state of the imported order | CuttingOptimizationImport / NestingOptimizationImport

IDGetMachines | GET | `_PREFIX_/optimizations/`⤶ `machines` | Returns the list of available machines | CuttingOptimizationImport / NestingOptimizationImport

IDGetParameters | GET | `_PREFIX_/optimizations/`⤶ `parameters` | Returns the list of available parameters | CuttingOptimizationImport / NestingOptimizationImport

[Deprecated] IDGetTemplates| GET | `_PREFIX_/optimizations/`⤶ `templates` | Returns the list of available templates | CuttingOptimizationImport / NestingOptimizationImport

IDGetTemplates | GET | `_PREFIX_/optimizations/`⤶ `templates/{templateType}` | Returns the list of available templates | CuttingOptimizationImport / NestingOptimizationImport Allowed values are: "cutting" or "nesting".

IDStartOptimization | POST | `_PREFIX_/optimizations/`⤶ `jobs/{jobId}/start` | Starts an optimization | OptExecCut / NestingOptimization

IDGetOptimizationState | GET | `_PREFIX_/optimizations/`⤶ `jobs/{jobId}/state` | Returns the optimization status (progress state) and if it is finished|OptExecCut / NestingOptimization / CuttingOptimizationImport

IDGetOptimizationSolutions | GET | `_PREFIX_/optimizations/`⤶ `jobs/{jobId}/solutions` | Returns the optimization solutions | OptExecCut / NestingOptimization

IDGetOptimizationSolutionData | GET | `_PREFIX_/optimizations/`⤶ `jobs/{jobId}/solutions/`⤶ `{solutionId}/data/{dataType}` | Returns the optimization solution data with the specified type Allowed values are: For cutting: saw / ptx For nesting: zip | OptExecCut / NestingOptimization

IDImportViaTemplate | POST | `_PREFIX_/optimizations/`⤶ `import/machine/{machineId}/`⤶ `parameter/{parameterId}/`⤶ `template/{templateId}{query}`| Creates a new optimization and imports information from csv or xls file with exiting template Allowed query parameters are: **jobName** for specifying a custom optimization job name **startOptimization** for also starting the job optimization | CuttingOptimizationImport

IDSendToPA | POST | `_PREFIX_/optimizations/`⤶ `import/template/{templateId}/`⤶ `productionAssist{query}` | Sends and aleady optimized SAW file to productionAssist Allowed query parameters are: **jobName** for specifying a custom optimization job name | CuttingOptimizationImport

| ------------------------------- | ------ | -------------------------------------------------------------------------------------------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------------------------------------------------------------------------------------------------- |

| IDImport | POST | `_PREFIX_/optimizations/`⤶ `import?machineId={machineId}`⤶ `&parameterId={parameterId}` | Uploads a ZIP-compressed order and optionally pass a machineId and parameterId If the id is also provided in the ZIP file, we will overwrite these settings with the id provided in the url. | CuttingOptimizationImport / NestingOptimizationImport |

| IDGetImportState | GET | `_PREFIX_/optimizations/`⤶ `import/states/{correlationId}` | Return state of the imported order | CuttingOptimizationImport / NestingOptimizationImport |

| IDGetTemplates | GET | `_PREFIX_/optimizations/`⤶ `templates/{templateType}` | Returns the list of available templates | CuttingOptimizationImport / NestingOptimizationImport Allowed values are: "cutting" or "nesting". |

| IDStartOptimization | POST | `_PREFIX_/optimizations/`⤶ `jobs/{jobId}/start` | Starts an optimization | OptExecCut / NestingOptimization |

| IDGetOptimizationState | GET | `_PREFIX_/optimizations/`⤶ `jobs/{jobId}/state` | Returns the optimization status (progress state) and if it is finished | OptExecCut / NestingOptimization / CuttingOptimizationImport |

| IDGetOptimizationSolutions | GET | `_PREFIX_/optimizations/`⤶ `jobs/{jobId}/solutions` | Returns the optimization solutions | OptExecCut / NestingOptimization |

| IDGetOptimizationSolutionData | GET | `_PREFIX_/optimizations/`⤶ `jobs/{jobId}/solutions/`⤶ `{solutionId}/data/{dataType}` | Returns the optimization solution data with the specified type Allowed values are: For cutting: saw / ptx For nesting: zip | OptExecCut / NestingOptimization |

| IDImportViaTemplate | POST | `_PREFIX_/optimizations/`⤶ `import/machine/{machineId}/`⤶ `parameter/{parameterId}/`⤶ `template/{templateId}{query}` | Creates a new optimization and imports information from csv or xls file with exiting template Allowed query parameters are: **jobName** for specifying a custom optimization job name **startOptimization** for also starting the job optimization | CuttingOptimizationImport |

| IDSendToPA | POST | `_PREFIX_/optimizations/`⤶ `import/template/{templateId}/`⤶ `productionAssist{query}` | Sends and aleady optimized SAW file to productionAssist Allowed query parameters are: **jobName** for specifying a custom optimization job name | CuttingOptimizationImport |

##### productionManager interface

Name |Method|API |Usage |Action group

-----------------------|------|-----------------------------------------------------------------------------------------------|---------------------------------------------------------|------------------

PMImport |POST | `_PREFIX_/productions/import` |Uploads a ZIP-compressed order |ProductionImport

PMGetImportState |GET | `_PREFIX_/productions/import/`⤶ `states/{correlationId}` |Return state of the imported order |ProductionImport

PMGetImportTemplates |GET | `_PREFIX_/productions/import/`⤶ `templates` |Returns all available templates |ProductionImport

PMImportViaTemplate |POST | `_PREFIX_/productions/import/`⤶ `templates/{templateId}/data`⤶ `?orderName={orderName}` |Creates a new customer order and imports production orders from file with existing template (templateId) Import is performed synchronously |ProductionImport

PMGetFeedbackWorkplaces|GET | `_PREFIX_/productions/feedback/`⤶ `workplaces` |Returns all available production feedback workplaces |ProductionFeedback

PMWorkplaceFeedback |POST | `_PREFIX_/productions/feedback/`⤶ `workplaces/`⤶ `{workplaceId}` |Add completed workplace feedback for specific production entities|ProductionFeedback

PMGetOrdersAsync |GET | `_PREFIX_/productions/orders` |Returns a list of orders that are not archived |ProductionImport

PMGetOrderDetailsAsync |GET | `_PREFIX_/productions/orders{orderId}?withParts={withParts}` |Returns detailed information for an order |ProductionImport

| ----------------------- | ------ | --------------------------------------------------------------------------------------------- | --------------------------------------------------------------------------------------------------------------------------------------------- | ------------------ |

| PMGetImportState | GET | `_PREFIX_/productions/import/`⤶ `states/{correlationId}` | Return state of the imported order | ProductionImport |

| PMImportViaTemplate | POST | `_PREFIX_/productions/import/`⤶ `templates/{templateId}/data`⤶ `?orderName={orderName}` | Creates a new customer order and imports production orders from file with existing template (templateId) Import is performed synchronously | ProductionImport |

| PMWorkplaceFeedback | POST | `_PREFIX_/productions/feedback/`⤶ `workplaces/`⤶ `{workplaceId}` | Add completed workplace feedback for specific production entities | ProductionFeedback |

| PMGetOrderDetailsAsync | GET | `_PREFIX_/productions/orders{orderId}?withParts={withParts}` | Returns detailed information for an order | ProductionImport |

##### materialManager interface

Name |Method | API | Usage | Action group

-----------------|-------|----------------------------------------|--------------------------------------------------------------|--------------

MMGetBoards | GET | `_PREFIX_/materials/boards/` | Return the list of available boards incl. link to images |QueryMaterials

MMGetEdges | GET | `_PREFIX_/materials/edges/` | Return the list of available edge bands incl. link to images |QueryMaterials

ImportInventory | POST | `_PREFIX_/storage/imports/inventory/` | Import a set of materials into materialManager |MaterialStorageImport

| --------------- | ------ | ------------------------------------- | ------------------------------------------------------------ | --------------------- |

#### Details

###### Output

Property | Description

-----------------|-------------------------------------------------------------------

subscriptionId | The id of the subscription

subscriptionName | The name of the customer subscription

applicationId | The guid of the application which the access token is assigned to

applicationName | The name of the application which the access token is assigned to

actionGroups | The list of allowed action groups

| Property | Description |

| ---------------- | ----------------------------------------------------------------- |

| subscriptionId | The id of the subscription |

| subscriptionName | The name of the customer subscription |

| applicationId | The guid of the application which the access token is assigned to |

| applicationName | The name of the application which the access token is assigned to |

| actionGroups | The list of allowed action groups |

The list of action groups contains of:

Property | Description

------------|-------------

actionGroup | This describes the API action group which can be used with this access token (e.g. customer has "intelliDivide cutting" and your token can access it => action group "OptImpCut" => so the import for cutting can be used); see also the interface overview for the required action groups for each API

| Property | Description |

| ----------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| actionGroup | This describes the API action group which can be used with this access token (e.g. customer has "intelliDivide cutting" and your token can access it => action group "OptImpCut" => so the import for cutting can be used); see also the interface overview for the required action groups for each API |

###### Example

###### Input

Parameter | Description

------------|-----------------------------------------------------------------------------------------------------------------------------

machineId | Optionally a machineId; will overwrite the setting in the zip file. For available machine ids, see `IDGetMachines`

parameterId | Optionally a parameterId; will overwrite the setting in the zip file. For available parameter ids, see `IDGetParameters`

(body) | The content type must be `application/zip` and the data should be send as a binary stream. The contents of this zip file is described in the documentation of the "Documentation of import/export definition for HOMAG digital products".

| Parameter | Description |

| ----------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| machineId | Optionally a machineId; will overwrite the setting in the zip file. For available machine ids, see `IDGetMachines` |

| parameterId | Optionally a parameterId; will overwrite the setting in the zip file. For available parameter ids, see `IDGetParameters` |

| (body) | The content type must be `application/zip` and the data should be send as a binary stream. The contents of this zip file is described in the documentation of the "Documentation of import/export definition for HOMAG digital products". |

###### Output

Property | Description

--------------|-------------

correlationId | The correlation id which can be used to query the state of the import. The import is executed asynchronously, so you need to query the state after you started the import to see if the import was successful or not.

| Property | Description |

| ------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |

| correlationId | The correlation id which can be used to query the state of the import. The import is executed asynchronously, so you need to query the state after you started the import to see if the import was successful or not. |

###### Example

```json

{

"correlationId": "EEF773F7-1140-44C7-8E74-FC3FAD1271D0",

"correlationId": "EEF773F7-1140-44C7-8E74-FC3FAD1271D0"

}

```

###### Input

Parameter | Description

--------------|-----------------------------------------------

correlationId | The correlation id from the call to `IDImport`

| Parameter | Description |

| ------------- | ---------------------------------------------- |

| correlationId | The correlation id from the call to `IDImport` |

###### Output

Property | Description

---------|------------------------------------------------------------------------------------------------------------------------

state | The state of the import. Possible states are: `Uploaded / Queued / InProgress / Succeeded / Error`

jobId | If the state is `Succeeded` we return the `jobId` which can be used to start the optimization

link | If the state is `Succeeded` we return a link which can be used to directly navigate to the optimization in the frontend

title | If the state is `Error` we return a localized error message

detail | If the state is `Error` we return an internal error description; this is not localized and more for debugging purpose

| Property | Description |

| -------- | ----------------------------------------------------------------------------------------------------------------------- |

| state | The state of the import. Possible states are: `Uploaded / Queued / InProgress / Succeeded / Error` |

| jobId | If the state is `Succeeded` we return the `jobId` which can be used to start the optimization |

| link | If the state is `Succeeded` we return a link which can be used to directly navigate to the optimization in the frontend |

| title | If the state is `Error` we return a localized error message |

| detail | If the state is `Error` we return an internal error description; this is not localized and more for debugging purpose |

###### Example

```json

{

"state": "Error",

"title": "Parameter file not valid",

"detail": "Wrong encoding found."

"title": "Parameter file not valid",

"detail": "Wrong encoding found."

}

```

]

}

```

##### intelliDivide interface: IDGetTemplates

Request

###### Output

Property | Description

----------------|------------------------------------------------------------------------------------------------------------------------------------------------------

state | The state of the optimization. Possible states are: `Unknown / None / Started / Canceled / Faulted / Completed / Created / Archived / Transfered`

startedAt | The RFC 3339 format of the date/time when the optimization was started

statePercentage | The percentage of the optimization progress. This is a double number from 0 to 1

error | If an error occurred this the the error text

| Property | Description |

| --------------- | ----------------------------------------------------------------------------------------------------------------------------------------------------- |

| state | The state of the optimization. Possible states are: `Unknown / None / Started / Canceled / Faulted / Completed / Created / Archived / Transfered` |

| startedAt | The RFC 3339 format of the date/time when the optimization was started |

| statePercentage | The percentage of the optimization progress. This is a double number from 0 to 1 |

| error | If an error occurred this the the error text |

##### Example

###### Input

Parameter | Description

-----------|--------------------------------------------------------------------------------------------------------------------

jobId | The id of the optimization job

solutionId | The id of the selected solution; you can only download data from ONE solution

dataType | The type of data which you want to download. Supported types are: For cutting: saw/ptx/pdf For nesting: zip

| Parameter | Description |

| ---------- | ------------------------------------------------------------------------------------------------------------------- |

| jobId | The id of the optimization job |

| solutionId | The id of the selected solution; you can only download data from ONE solution |

| dataType | The type of data which you want to download. Supported types are: For cutting: saw/ptx/pdf For nesting: zip |

###### Output

The body contains the data of the requested data type. It will be returned in the following format:

Data type | Content-Type

----------|------------------------

saw | text/saw; charset=utf-8

ptx | text/ptx; charset=utf-8

zip | application/zip

| Data type | Content-Type |

| --------- | ----------------------- |

| saw | text/saw; charset=utf-8 |

| ptx | text/ptx; charset=utf-8 |

| zip | application/zip |

###### Example

###### Input

Parameter | Description

------------------|---------------------------------------------------------------------------------------------------------------------------------------------

machineId | The Id of the machine used to process the file import

parameterId | The Id of the optimization parameter used to process the file import

templateId | The Id of the template used to process the file import

jobName | Optionally pass the name of the newly created customer optimization If no jobName is passed, the file name will be used as customer optimization name

startOptimization | Optionally pass a boolean to start the job optimization If no startOptimization is passed or the value passed is false, the optimization will not start automatically

| Parameter | Description |

| ----------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------ |

| machineId | The Id of the machine used to process the file import |

| parameterId | The Id of the optimization parameter used to process the file import |

| templateId | The Id of the template used to process the file import |

| jobName | Optionally pass the name of the newly created customer optimization If no jobName is passed, the file name will be used as customer optimization name |

| startOptimization | Optionally pass a boolean to start the job optimization If no startOptimization is passed or the value passed is false, the optimization will not start automatically |

###### Example 1 (default)

We currently return the following import states:

* Succeeded / Error

- Succeeded / Error

Response (200 Ok)

```json

{

"state": "Error",

"errorText": "The data of the import file is in an unexpected format.",

"errorDetails": "No header record was found.\r\nIReader state:\r\n ColumnCount: 0\r\n CurrentIndex: -1\r\n HeaderRecord:\r\n\r\nIParser state:\r\n ByteCount: 0\r\n CharCount: 26\r\n Row: 5\r\n RawRow: 5\r\n Count: 0\r\n RawRecord:\r\n\r\n"

"errorText": "The data of the import file is in an unexpected format.",

"errorDetails": "No header record was found.\r\nIReader state:\r\n ColumnCount: 0\r\n CurrentIndex: -1\r\n HeaderRecord:\r\n\r\nIParser state:\r\n ByteCount: 0\r\n CharCount: 26\r\n Row: 5\r\n RawRow: 5\r\n Count: 0\r\n RawRecord:\r\n\r\n"

}

```

```json

{

"state": "Error",

"errorText": "No data could be identified for import. Please check the file and the import template"

}

```

Authorization: Basic NjU1MDFEMDktMkJCOS00M0MyLUI5RDMtMUZCMDAwNkE3NjlFOnNkMDlzaGR1Z985OGffc2ZkZ3pz32Y5ZGhzYWZkaHNmZN92ODlwYmZkOXZiaGFmZGd2

tracestate: someinternaltracedata

```

For content and response see above (Example 1).

###### Examlpe 3 (with startOptimization)

Authorization: Basic NjU1MDFEMDktMkJCOS00M0MyLUI5RDMtMUZCMDAwNkE3NjlFOnNkMDlzaGR1Z985OGffc2ZkZ3pz32Y5ZGhzYWZkaHNmZN92ODlwYmZkOXZiaGFmZGd2

tracestate: someinternaltracedata

```

For content and response see above (Example 1).

##### intelliDivide interface: IDSendToPA

###### Input

Parameter | Description

------------------|---------------------------------------------------------------------------------------------------------------------------------------------

templateId | The Id of the template used to process the file import

jobName | Optionally pass the name of the newly created customer optimization If no jobName is passed, the file name will be used as customer optimization name

| Parameter | Description |

| ---------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- |

| templateId | The Id of the template used to process the file import |

| jobName | Optionally pass the name of the newly created customer optimization If no jobName is passed, the file name will be used as customer optimization name |

###### Example 1 (default)

We currently return the following import states:

* Succeeded / Error

- Succeeded / Error

Response (200 Ok)

```json

{

"state": "Error",

"errorText": "The data of the import file is in an unexpected format.",

"errorDetails": "No header record was found.\r\nIReader state:\r\n ColumnCount: 0\r\n CurrentIndex: -1\r\n HeaderRecord:\r\n\r\nIParser state:\r\n ByteCount: 0\r\n CharCount: 26\r\n Row: 5\r\n RawRow: 5\r\n Count: 0\r\n RawRecord:\r\n\r\n"

"errorText": "The data of the import file is in an unexpected format.",

"errorDetails": "No header record was found.\r\nIReader state:\r\n ColumnCount: 0\r\n CurrentIndex: -1\r\n HeaderRecord:\r\n\r\nIParser state:\r\n ByteCount: 0\r\n CharCount: 26\r\n Row: 5\r\n RawRow: 5\r\n Count: 0\r\n RawRecord:\r\n\r\n"

}

```

```json

{

"state": "Error",

"errorText": "No data could be identified for import. Please check the file and the import template"

}

```

Authorization: Basic NjU1MDFEMDktMkJCOS00M0MyLUI5RDMtMUZCMDAwNkE3NjlFOnNkMDlzaGR1Z985OGffc2ZkZ3pz32Y5ZGhzYWZkaHNmZN92ODlwYmZkOXZiaGFmZGd2

tracestate: someinternaltracedata

```

For content and response see above (Example 1).

##### productionManager interface: PMImport (Example)

MMGetBoardsTests.cs

/Samples/csharp/HomagGroup.ApiGateway.Client.Samples/MMGetBoardsTests.cs

View

MMGetEdgesTests.cs

/Samples/csharp/HomagGroup.ApiGateway.Client.Samples/MMGetEdgesTests.cs

View

HISTORY.md

/HISTORY.md

View



	Client/HomagGroup.DigitalFactory.ApiGateway.Client
	Interfaces
	IMaterialsService.cs
	Services
	MaterialsService.cs
	Documentation
	README.md
	Samples/csharp/HomagGroup.ApiGateway.Client.Samples
	MMGetBoardsTests.cs +
	MMGetEdgesTests.cs +
	HISTORY.md