CodeSets

Codeset Configuration

/v1/codesets/{id}

Codeset Configuration

Example for calling:

http://server/v1/codesets/9 - retrieves codeset related to network with network Id = 9

http://server/v1/codesets?id=1 - retrieves codeset having Id = 1

http://server/v1/codesets?network_id=9 - retrieves codeset related to network with network id = 9

http://server/v1/codesets?network_id=9&meta_field_select=DLF - retrieves codeset related to network with network id = 9 limited to date, flag and text fields

http://server/v1/codesets?network_id=9&meta_field_select=D,L,F - retrieves codeset related to network with network id = 9 limited to date, flag and text fields

http://server/v1/codesets?network_id=9&meta_field_select=R1,R2,D - retrieves codeset related to network with network id = 9 limited to R field 1 and 2 and all date fields

http://server/v1/codesets - retrieves all codesets

Allowed Methods:

[GET]
API Controller: Codeset

Description:

Retrieves the configuration detail for specified codeset or all codesets if no ID is specified. Only defined userfields are included.

Codeset and master codeset

A definition of a "codeset" could be connected to another "codeset", here referred to as a "master codeset". When requesting details for a "code set" connected to a "master codeset", the "reference value" will be retrieved from the "master codeset". The "reference fields" values will be retrieved from the "codeset". When a "codeset" is not connected to other codesets, all values will be retrieved from the "codeset" it selves.

Using Reference Fields in Safran Solution

In the Safran Solution (such as Safran Project), "Reference Fields" can reference not only their local set or a master set but also other database tables. This is achieved through an "Advanced SQL" configuration within the Safran Solution.

When using the API, it expects the SQL query to return three columns with the following data types:

1. Integer
2. String
3. String

If your columns are of different types, you need to cast them within the SQL command to match the expected types.

Example for MS SQL:

SELECT seq, CONVERT(nvarchar(50), wpn) AS wpn, an 
FROM activities 
WHERE net_id = 2 AND seq = 3;

Example for Oracle:

SELECT SEQ, TO_CHAR(WPN) AS WPN, an
FROM ACTIVITIES
WHERE NET_ID = 2 AND SEQ = 3;

In this example:

• seq is an integer.
• wpn is converted to a string using CONVERT(nvarchar(50), wpn).
• an is a string.

Ensure that your SQL query aligns with these requirements to avoid any issues.

Parameters:

• Combining id with network_id is not supported
• When "SafranWebApiOwnerVerificationDuringApiCalls" is used, the CodeSet retrieved can only be linked to projects owned by the same owner as the CodeSet. Should the CodeSet be linked to other projets, owned by others, the API will return failure. Unless meta_field_select=0.
• When meta_field_select=0 and the "SafranWebApiOwnerVerificationDuringApiCalls" are in use, the owner is mandatory, but neither of the IDs is.
• When specifying meta_field_select and leaving out some fields, the JSON will still contain the fields left out. The element for the fields left out will be empty.
• When specifying meta_field_select with "ExcludeValues", the "outline_code" will contain empty "outline_values[]" and the "reference_field" will contain empty "reference_value[]" elements.
• When specifying meta_field_select with the combination of "ExcludeValues" and "0" as in "0, ExcludeValues" makes no sense and will be responded with "Bad Request".
  
  

Response Fields:

Reference Fields:

Reference Value:

Generic Field:

This generic field structure is present where generic user fields have been defined in the codeset (date_fields, decimal_fields, duration_fields, flag_fields, number_fields, or text_fields).

number fields are no longer used in Safran 7. Decimal fields are used instead.

outline_code:

Level:

Outline_Value:

[
  {
    "date_fields": [
    ],
    "flag_fields": [
    ],
    "number_fields": [
    ],
    "decimal_fields": [
    ],
    "duration_fields": [
    ],
    "outline_codes": [
    ],
    "id": 1,
    "name": "Safran Software Solutions AS - 1",
    "owner": "SAFRANSA",
    "reference_fields": [
      {
        "reference_values": [
          {
            "description": "Procurement (Master)",
            "_short": "PO (M)"
          }
        ],
        "field_nr": 1,
        "label": "API Test.R1 (Local)",
        "inherit_label": false,
        "visible": true,
        "enabled": true,
        "inherit_field_nr": 44,
        "inherit_id": 141,
        "inherit_sql": "SELECT code, short, description FROM codeset WHERE rfield_nr = 44 and config_id = 141"
      }
      
    ],
    "text_fields": [
      {
        "field_nr": 1,
        "label": "ABC Activity Code",
        "visible": true,
        "enabled": true
        "inherit_field_nr": 1,
        "inherit_id": 141,
      },
      {
        "field_nr": 2,
        "label": "DEF no",
        "visible": true,
        "enabled": true
        
      }
      
    ]
    
  }
]