ScreenDefinition

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getScreenDefinition

post

Retrieve screen definition

Authorizations

Body

ScreenDefinitionScreenSelectionintegerOptional

ScreenDefinitionTypeintegerOptional

Responses

200

Successful operation.

application/json

post

/getScreenDefinition

POST /nexum/627/2022.01/parameter/getScreenDefinition HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 185

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ScreenDefinitionScreenSelection": 1,
  "ScreenDefinitionType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "ScreenDefinition": {
    "Field1": [
      {
        "EntryId": 1,
        "Field1": 1
      }
    ],
    "Field5": [
      {
        "EntryId": 1,
        "Field5": "text"
      }
    ],
    "LCol": [
      {
        "EntryId": 1,
        "LCol": 1
      }
    ],
    "Line": [
      {
        "EntryId": 1,
        "Line": 1
      }
    ],
    "RCol": [
      {
        "EntryId": 1,
        "RCol": 1
      }
    ],
    "Row": [
      {
        "EntryId": 1,
        "Row": 1
      }
    ],
    "Side": [
      {
        "EntryId": 1,
        "Side": 1
      }
    ],
    "SubField": [
      {
        "EntryId": 1,
        "SubField": 1
      }
    ],
    "ScreenSelection": 1,
    "Type": 1
  }
}

getScreenDefinitionSelectFields

post

Returns the screen definitions with select fields

Authorizations

Body

ScreenDefinitionScreenSelectionintegerOptional

ScreenDefinitionTypeintegerOptional

Responses

200

Successful operation.

application/json

post

/getScreenDefinitionSelectFields

POST /nexum/627/2022.01/parameter/getScreenDefinitionSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 403

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ScreenDefinitionScreenSelection": 1,
  "ScreenDefinitionType": 1,
  "SelectableFields": {
    "IncludeAllScreenDefinitionFields": true,
    "ScreenDefinitionFields": {
      "Field1": [
        1
      ],
      "Field5": [
        1
      ],
      "LCol": [
        1
      ],
      "Line": [
        1
      ],
      "RCol": [
        1
      ],
      "Row": [
        1
      ],
      "ScreenSelection": true,
      "Side": [
        1
      ],
      "SubField": [
        1
      ],
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "ScreenDefinition": {
    "Field1": [
      {
        "EntryId": 1,
        "Field1": 1
      }
    ],
    "Field5": [
      {
        "EntryId": 1,
        "Field5": "text"
      }
    ],
    "LCol": [
      {
        "EntryId": 1,
        "LCol": 1
      }
    ],
    "Line": [
      {
        "EntryId": 1,
        "Line": 1
      }
    ],
    "RCol": [
      {
        "EntryId": 1,
        "RCol": 1
      }
    ],
    "Row": [
      {
        "EntryId": 1,
        "Row": 1
      }
    ],
    "Side": [
      {
        "EntryId": 1,
        "Side": 1
      }
    ],
    "SubField": [
      {
        "EntryId": 1,
        "SubField": 1
      }
    ],
    "ScreenSelection": 1,
    "Type": 1
  }
}

getScreenDefinitionPagedList

post

Returns paged list of screen definitions

Authorizations

Body

Responses

200

Successful operation.

application/json

post

/getScreenDefinitionPagedList

POST /nexum/627/2022.01/parameter/getScreenDefinitionPagedList HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "ScreenDefinition": [
    {
      "Field1": [
        {
          "EntryId": 1,
          "Field1": 1
        }
      ],
      "Field5": [
        {
          "EntryId": 1,
          "Field5": "text"
        }
      ],
      "LCol": [
        {
          "EntryId": 1,
          "LCol": 1
        }
      ],
      "Line": [
        {
          "EntryId": 1,
          "Line": 1
        }
      ],
      "RCol": [
        {
          "EntryId": 1,
          "RCol": 1
        }
      ],
      "Row": [
        {
          "EntryId": 1,
          "Row": 1
        }
      ],
      "Side": [
        {
          "EntryId": 1,
          "Side": 1
        }
      ],
      "SubField": [
        {
          "EntryId": 1,
          "SubField": 1
        }
      ],
      "ScreenSelection": 1,
      "Type": 1
    }
  ],
  "Token": "text"
}

getScreenDefinitionListSelectFields

post

Returns the list of screen definitions with select fields

Authorizations

Body

Responses

200

Successful operation.

application/json

post

/getScreenDefinitionListSelectFields

POST /nexum/627/2022.01/parameter/getScreenDefinitionListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 342

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllScreenDefinitionFields": true,
    "ScreenDefinitionFields": {
      "Field1": [
        1
      ],
      "Field5": [
        1
      ],
      "LCol": [
        1
      ],
      "Line": [
        1
      ],
      "RCol": [
        1
      ],
      "Row": [
        1
      ],
      "ScreenSelection": true,
      "Side": [
        1
      ],
      "SubField": [
        1
      ],
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "ScreenDefinitionList": {
    "hasReachedMaximumListSize": true,
    "ScreenDefinition": [
      {
        "Field1": [
          {
            "EntryId": 1,
            "Field1": 1
          }
        ],
        "Field5": [
          {
            "EntryId": 1,
            "Field5": "text"
          }
        ],
        "LCol": [
          {
            "EntryId": 1,
            "LCol": 1
          }
        ],
        "Line": [
          {
            "EntryId": 1,
            "Line": 1
          }
        ],
        "RCol": [
          {
            "EntryId": 1,
            "RCol": 1
          }
        ],
        "Row": [
          {
            "EntryId": 1,
            "Row": 1
          }
        ],
        "Side": [
          {
            "EntryId": 1,
            "Side": 1
          }
        ],
        "SubField": [
          {
            "EntryId": 1,
            "SubField": 1
          }
        ],
        "ScreenSelection": 1,
        "Type": 1
      }
    ]
  }
}

searchScreenDefinitionSelectFields

post

Retrieve a list of select fields for screen definitions

Authorizations

Body

Responses

200

Successful operation.

application/json

post

/searchScreenDefinitionSelectFields

POST /nexum/627/2022.01/parameter/searchScreenDefinitionSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 374

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllScreenDefinitionFields": true,
    "ScreenDefinitionFields": {
      "Field1": [
        1
      ],
      "Field5": [
        1
      ],
      "LCol": [
        1
      ],
      "Line": [
        1
      ],
      "RCol": [
        1
      ],
      "Row": [
        1
      ],
      "ScreenSelection": true,
      "Side": [
        1
      ],
      "SubField": [
        1
      ],
      "Type": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "ScreenDefinitionList": {
    "hasReachedMaximumListSize": true,
    "ScreenDefinition": [
      {
        "Field1": [
          {
            "EntryId": 1,
            "Field1": 1
          }
        ],
        "Field5": [
          {
            "EntryId": 1,
            "Field5": "text"
          }
        ],
        "LCol": [
          {
            "EntryId": 1,
            "LCol": 1
          }
        ],
        "Line": [
          {
            "EntryId": 1,
            "Line": 1
          }
        ],
        "RCol": [
          {
            "EntryId": 1,
            "RCol": 1
          }
        ],
        "Row": [
          {
            "EntryId": 1,
            "Row": 1
          }
        ],
        "Side": [
          {
            "EntryId": 1,
            "Side": 1
          }
        ],
        "SubField": [
          {
            "EntryId": 1,
            "SubField": 1
          }
        ],
        "ScreenSelection": 1,
        "Type": 1
      }
    ]
  }
}

getScreenDefinitionPagedListSelectFields

post

Returns paged list of screen definitions with select fields

Authorizations

Body

Responses

200

Successful operation.

application/json

post

/getScreenDefinitionPagedListSelectFields

POST /nexum/627/2022.01/parameter/getScreenDefinitionPagedListSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 436

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllScreenDefinitionFields": true,
    "ScreenDefinitionFields": {
      "Field1": [
        1
      ],
      "Field5": [
        1
      ],
      "LCol": [
        1
      ],
      "Line": [
        1
      ],
      "RCol": [
        1
      ],
      "Row": [
        1
      ],
      "ScreenSelection": true,
      "Side": [
        1
      ],
      "SubField": [
        1
      ],
      "Type": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "ScreenDefinition": [
    {
      "Field1": [
        {
          "EntryId": 1,
          "Field1": 1
        }
      ],
      "Field5": [
        {
          "EntryId": 1,
          "Field5": "text"
        }
      ],
      "LCol": [
        {
          "EntryId": 1,
          "LCol": 1
        }
      ],
      "Line": [
        {
          "EntryId": 1,
          "Line": 1
        }
      ],
      "RCol": [
        {
          "EntryId": 1,
          "RCol": 1
        }
      ],
      "Row": [
        {
          "EntryId": 1,
          "Row": 1
        }
      ],
      "Side": [
        {
          "EntryId": 1,
          "Side": 1
        }
      ],
      "SubField": [
        {
          "EntryId": 1,
          "SubField": 1
        }
      ],
      "ScreenSelection": 1,
      "Type": 1
    }
  ],
  "Token": "text"
}

searchScreenDefinitionPagedSelectFields

post

Retrieve a paged list of select fields for screen definitions

Authorizations

Body

QuerystringOptional

Responses

200

Successful operation.

application/json

post

/searchScreenDefinitionPagedSelectFields

POST /nexum/627/2022.01/parameter/searchScreenDefinitionPagedSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 451

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllScreenDefinitionFields": true,
    "ScreenDefinitionFields": {
      "Field1": [
        1
      ],
      "Field5": [
        1
      ],
      "LCol": [
        1
      ],
      "Line": [
        1
      ],
      "RCol": [
        1
      ],
      "Row": [
        1
      ],
      "ScreenSelection": true,
      "Side": [
        1
      ],
      "SubField": [
        1
      ],
      "Type": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "ScreenDefinition": [
    {
      "Field1": [
        {
          "EntryId": 1,
          "Field1": 1
        }
      ],
      "Field5": [
        {
          "EntryId": 1,
          "Field5": "text"
        }
      ],
      "LCol": [
        {
          "EntryId": 1,
          "LCol": 1
        }
      ],
      "Line": [
        {
          "EntryId": 1,
          "Line": 1
        }
      ],
      "RCol": [
        {
          "EntryId": 1,
          "RCol": 1
        }
      ],
      "Row": [
        {
          "EntryId": 1,
          "Row": 1
        }
      ],
      "Side": [
        {
          "EntryId": 1,
          "Side": 1
        }
      ],
      "SubField": [
        {
          "EntryId": 1,
          "SubField": 1
        }
      ],
      "ScreenSelection": 1,
      "Type": 1
    }
  ],
  "Token": "text"
}

updateScreenDefinitionByID

post

Update screen definitions by ID

Authorizations

Body

ScreenDefinitionScreenSelectionintegerOptional

ScreenDefinitionTypeintegerOptional

Responses

200

Successful operation.

application/json

post

/updateScreenDefinitionByID

POST /nexum/627/2022.01/parameter/updateScreenDefinitionByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 496

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ScreenDefinitionScreenSelection": 1,
  "ScreenDefinitionType": 1,
  "ScreenDefinitionUpdatableFields": {
    "Field1": [
      {
        "EntryId": 1,
        "Field1": 1
      }
    ],
    "Field5": [
      {
        "EntryId": 1,
        "Field5": "text"
      }
    ],
    "LCol": [
      {
        "EntryId": 1,
        "LCol": 1
      }
    ],
    "Line": [
      {
        "EntryId": 1,
        "Line": 1
      }
    ],
    "RCol": [
      {
        "EntryId": 1,
        "RCol": 1
      }
    ],
    "Row": [
      {
        "EntryId": 1,
        "Row": 1
      }
    ],
    "Side": [
      {
        "EntryId": 1,
        "Side": 1
      }
    ],
    "SubField": [
      {
        "EntryId": 1,
        "SubField": 1
      }
    ]
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}

PreviousRegCc NextSecField

Last updated 1 year ago

Was this helpful?