Get UserFieldSet simple

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

Get UserFieldSet simple

/v1/userfieldsets

UserFieldSet in simple format.

Safran Project ILAP Gateway

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

Example for calling:

http://server/v1/userfieldsets - Gets all user field sets
http://server/v1/userfieldsets?id=6 - Gets user field set with ID 6
http://server/v1/userfieldsets?id=6&owner=SAFRANSA - Gets user fields set with ID 6 and owned by SAFRANSA
http://server/v1/userfieldsets?owner=SAFRANSA - Gets all user fields sets owner by SAFRANSA

Allowed Methods:

[GET]
API Controller: CodeSet

Description:

Retrieves the configuration detail for specified user field sets if no Id or owner is specified.

Parameters:

Name	Type	Description	Notes
id	integer	Codeset ID
owner	string	Owner of the code set	Relates to "SafranWebApiOwnerVerificationDuringApiCalls" in "Application Settings"

When "SafranWebApiOwnerVerificationDuringApiCalls" is in use, the CodeSet retrieved can only be linked to projects owned by the same owner as the CodeSet. Should the CodeSet be linked to other projects, owned by others, the API will return failure. Unless meta_field_select=0.

Response Fields:

Name	Type	Description
id	integer	The unique code set Id
name	string	The code set name
owner	string	The owner of the code set (Username)
fields	fields[]	Collection of defined field objects

Fields:

Name	Type	Description	Notes
name	string	The name of the field	The format of the name: "uf_" + <field type> + <field number>
label	string	Field label
visible	boolean	Field visible	Tell if field is visible (true), values true or false
enabled	boolean	Field enabled	Tell if field is enabled (true), values true or false
inherit_label	boolean	Field label inherit	Tell if (true) the label is inherited from the master set and it will be shown in Safran UI. Else (false) the label of this field will shown. The default value is false

Sample JSON Response

[
  {
    "id": 1,
    "name": "Safran Software Solutions - 1",
    "owner": "SAFRANSA",
    "fields": [
      {
        "name": "uf_date1",
        "label": "Date 1",
        "inherit_label": false,
        "visible": true,
        "enabled": true
      },
      {
        "name": "uf_date2",
        "label": "Date 2",
        "inherit_label": false,
        "visible": true,
        "enabled": true
      },
      {
        "name": "uf_ref1",
        "label": "Reference field 1",
        "inherit_label": false,
        "visible": true,
        "enabled": true
      }
    ]
  }
]

Was this article helpful?

What's Next

Change Order

Table of contents