Create Forecast Header Description - Intergraph Smart Materials - Version 2017 (2.0) - Help - Hexagon PPM

Intergraph Smart Materials Web API Help 2017 (2.0)

PPMProduct
Intergraph Smart Materials
PPMCategory_custom
Help

Name and Description

Forecast Header Description - HeaderNls is an action on a forecast entity that creates the language dependent description of the forecast header.

URL Format

/Projects (':project')/Disciplines(':discipline')/Nls(':language')/ Com.Ingr.Smat.V1. ForecastHeaders(‘:key’)/ForecastDescription/

Specify values for project, discipline, language and key parameters in the URL. The first three values together define a project environment in which the forecast header is created. The key parameter defines the forecast header id, for which the description is created.

Use the following read-only APIs to get the available values for each parameter.

/Projects,

/projects(':project')/Disciplines,

/projects(':project')/Disciplines(':discipline')/nls

URL Parameter

:project, :discipline, :language, :key

Method

POST

Required Privilege

API_CREATE_FAHEADER

Data Parameter

The payload of the request should be in JSON format and which will have the following structure:

<Action Name="ForecastDescription" IsBound="true">

<Parameter Name="bindingParameter" 

Type="Com.Ingr.Smat.Core.V1.Forecast"/>

<Parameter Name="HeaderNls" 

Type="Com.Ingr.Smat.Core.V1.HeaderDescription"/>

<ReturnType Type="Edm.Int64" Nullable="false"/>

</Action>

Below is the JSON structure of Com.Ingr.Smat.Core.V1.HeaderDescription type:

<ComplexType Name="HeaderDescription">

<Property Name="NlsId" Type="Edm.Decimal" Nullable="false"/>

<Property Name="ShortDesc" Type="Edm.String" Nullable="false"/>

<Property Name="Description" Type="Edm.String" Nullable="false"/>

</ComplexType>

Where:

NlsId (Edm.Decimal, Not Nullable): The unique identifier for the national language.

ShortDesc (Edm.String, Not Nullable): Short description for the forecast run.

Description (Edm.String, Not Nullable): Long description for the forecast run.

Example:

{

"HeaderNls":{

"NlsId ":1,

"ShortDesc ":'short description',

"Description ":'This is long description'

}

}

Success Response

HTTP status code sent back to client on the API execution success: 
Code: 200 OK

Content:

{

"@odata.context": "https://{host}/Smat/V1/$metadata#Edm.Int64",

"value": 0

}

Error Response

This API may fail with the following error messages:

Error Code: 401 Unauthorized

Content:

{

"error": {

"code": "",

"message": "Authorization has been denied for this request."}

}

Notes