Create new OutlineCodes

Updated on 18 Jul 2024
1 Minute to read
Contributors

Print
Share
Dark
Light
PDF

Article summary

Did you find this summary helpful?

Thank you for your feedback

Create new OutlineCodes

/v1/outline_codes

Maintain Resources

Safran Project ILAP Gateway

This API is only available in the Safran Project ILAP Gateway product.

Example for calling:

http://server/v1/outline_codes
Request Body = {...} see request fields below

Allowed Methods:

[POST]
API Controller: OutlineCodes

### Description
Outline Codes can only be created.

Request Fields:

Name	Type	Description	Notes
Config_id	integer	Codeset ID	Refers to the Code Configuration
field_nr	integer	Field number identifies userfield (ex: 1 og 30)
label	nvarchar (40)	Field label identified name of userfield
oc_levels	integer	Maximum outline levels in structure
generate_level_labels	integer	Level labels in select_stmt (names for each level in structure) Optional
generate_level_masks	integer	Level masks in valid_stmt (chart type, field lenght, divider char, etc.)
outline_values table	table	Table with outline codes

outline_values table

Name	Type	Description
RowID	integer	Sequential order of codes. Need to go from top level downawrds.
parent_path	nvarchar ()	Specify full path of parent, rather then using internal sequences
_short	nvarchar (100)	Outline code short description
description	nvarchar (255)	Outline code description

Response Fields:

Name	Type	Description
field_nr	integer	Field number identifies userfield (ex: 1 of 30)
Result	byte	S(uccess) or F(ail) indicating if the requested action was successfully executed
Message	string	Empty if success; error message if the requested action failed.
MessageId	integer	MessageId: Identifies error message
outline_codes table	table	Table with outline codes

outline_code table

Name	Type	Description
RowID	integer	Sequential order of codes. Need to go from top level down order
Result	byte	S(uccess) or F(ail) indicating if the requested action was successfully executed
Message	string	Empty if success; error message if the requested action failed.
MessageID	integer	Identifies error message

Sample JSON Request

[
    {
        "Config_id": 1,
        "field_nr": 1,
        "label": "Outline1",
        "oc_levels": 3,
        "generate_level_labels": 0,
        "generate_level_masks": 0,
        "outline_values": [
            {
                "RowID": 1,
                "parent_path": "",
                "_short": "Code1",
                "description": "Outline Description 1"
            },
            {
                "RowID": 2,
                "parent_path": "Code1",
                "_short": "Code2",
                "description": "Outline Description 2"
            },
            {
                "RowID": 3,
                "parent_path": "Code2",
                "_short": "Code3",
                "description": "Outline Description 3"
            }
        ]
    },
    {
        "Config_id": 1,
        "field_nr": 2,
        "label": "Outline2",
        "oc_levels": 1,
        "generate_level_labels": 0,
        "generate_level_masks": 0,
        "outline_values": [
            {
                "RowID": 4,
                "parent_path": "",
                "_short": "Code1",
                "description": "Outline Description 1"
            }
        ]
    }
]

Sample JSON Response

[
    {
        "field_nr": 1,
        "RowId": 0,
        "Result": "S",
        "Message": ""
    },
    {
        "field_nr": 2,
        "RowId": 0,
        "Result": "S",
        "Message": ""
    }
]

Was this article helpful?

What's Next

Patch Codeset

Table of contents