SecField

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getSecField

post

Retrieve security field

Authorizations

Body

SecFieldRecordSelectionintegerRequired

Responses

200

Successful operation.

application/json

post

/getSecField

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

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

200

Successful operation.

{
  "SecField": {
    "CreSecField": [
      {
        "EntryId": 1,
        "CreSecField": 1
      }
    ],
    "ReqSecField": [
      {
        "EntryId": 1,
        "ReqSecField": 1
      }
    ],
    "RequireField": [
      {
        "EntryId": 1,
        "RequireField": 1
      }
    ],
    "RevSecField": [
      {
        "EntryId": 1,
        "RevSecField": 1
      }
    ],
    "RecordSelection": 1
  }
}

getSecFieldSelectFields

post

Returns the security fields with select fields

Authorizations

Body

SecFieldRecordSelectionintegerOptional

Responses

200

Successful operation.

application/json

post

/getSecFieldSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SecFieldRecordSelection": 1,
  "SelectableFields": {
    "IncludeAllSecFieldFields": true,
    "SecFieldFields": {
      "CreSecField": [
        1
      ],
      "RecordSelection": true,
      "ReqSecField": [
        1
      ],
      "RequireField": [
        1
      ],
      "RevSecField": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "SecField": {
    "CreSecField": [
      {
        "EntryId": 1,
        "CreSecField": 1
      }
    ],
    "ReqSecField": [
      {
        "EntryId": 1,
        "ReqSecField": 1
      }
    ],
    "RequireField": [
      {
        "EntryId": 1,
        "RequireField": 1
      }
    ],
    "RevSecField": [
      {
        "EntryId": 1,
        "RevSecField": 1
      }
    ],
    "RecordSelection": 1
  }
}

getSecFieldPagedList

post

Returns paged list of security fields

Authorizations

Body

Responses

200

Successful operation.

application/json

post

/getSecFieldPagedList

POST /nexum/627/2022.01/parameter/getSecFieldPagedList 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.

{
  "SecField": [
    {
      "CreSecField": [
        {
          "EntryId": 1,
          "CreSecField": 1
        }
      ],
      "ReqSecField": [
        {
          "EntryId": 1,
          "ReqSecField": 1
        }
      ],
      "RequireField": [
        {
          "EntryId": 1,
          "RequireField": 1
        }
      ],
      "RevSecField": [
        {
          "EntryId": 1,
          "RevSecField": 1
        }
      ],
      "RecordSelection": 1
    }
  ],
  "Token": "text"
}

getSecFieldListSelectFields

post

Returns the list of security fields with select fields

Authorizations

Body

Responses

200

Successful operation.

application/json

post

/getSecFieldListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllSecFieldFields": true,
    "SecFieldFields": {
      "CreSecField": [
        1
      ],
      "RecordSelection": true,
      "ReqSecField": [
        1
      ],
      "RequireField": [
        1
      ],
      "RevSecField": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "SecFieldList": {
    "hasReachedMaximumListSize": true,
    "SecField": [
      {
        "CreSecField": [
          {
            "EntryId": 1,
            "CreSecField": 1
          }
        ],
        "ReqSecField": [
          {
            "EntryId": 1,
            "ReqSecField": 1
          }
        ],
        "RequireField": [
          {
            "EntryId": 1,
            "RequireField": 1
          }
        ],
        "RevSecField": [
          {
            "EntryId": 1,
            "RevSecField": 1
          }
        ],
        "RecordSelection": 1
      }
    ]
  }
}

searchSecFieldSelectFields

post

Retrieve a list of select fields for security fields

Authorizations

Body

Responses

200

Successful operation.

application/json

post

/searchSecFieldSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllSecFieldFields": true,
    "SecFieldFields": {
      "CreSecField": [
        1
      ],
      "RecordSelection": true,
      "ReqSecField": [
        1
      ],
      "RequireField": [
        1
      ],
      "RevSecField": [
        1
      ]
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "SecFieldList": {
    "hasReachedMaximumListSize": true,
    "SecField": [
      {
        "CreSecField": [
          {
            "EntryId": 1,
            "CreSecField": 1
          }
        ],
        "ReqSecField": [
          {
            "EntryId": 1,
            "ReqSecField": 1
          }
        ],
        "RequireField": [
          {
            "EntryId": 1,
            "RequireField": 1
          }
        ],
        "RevSecField": [
          {
            "EntryId": 1,
            "RevSecField": 1
          }
        ],
        "RecordSelection": 1
      }
    ]
  }
}

getSecFieldPagedListSelectFields

post

Returns paged list of security fields with select fields

Authorizations

Body

Responses

200

Successful operation.

application/json

post

/getSecFieldPagedListSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllSecFieldFields": true,
    "SecFieldFields": {
      "CreSecField": [
        1
      ],
      "RecordSelection": true,
      "ReqSecField": [
        1
      ],
      "RequireField": [
        1
      ],
      "RevSecField": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "SecField": [
    {
      "CreSecField": [
        {
          "EntryId": 1,
          "CreSecField": 1
        }
      ],
      "ReqSecField": [
        {
          "EntryId": 1,
          "ReqSecField": 1
        }
      ],
      "RequireField": [
        {
          "EntryId": 1,
          "RequireField": 1
        }
      ],
      "RevSecField": [
        {
          "EntryId": 1,
          "RevSecField": 1
        }
      ],
      "RecordSelection": 1
    }
  ],
  "Token": "text"
}

searchSecFieldPagedSelectFields

post

Retrieve a paged list of select fields for security fields

Authorizations

Body

QuerystringOptional

Responses

200

Successful operation.

application/json

post

/searchSecFieldPagedSelectFields

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllSecFieldFields": true,
    "SecFieldFields": {
      "CreSecField": [
        1
      ],
      "RecordSelection": true,
      "ReqSecField": [
        1
      ],
      "RequireField": [
        1
      ],
      "RevSecField": [
        1
      ]
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "SecField": [
    {
      "CreSecField": [
        {
          "EntryId": 1,
          "CreSecField": 1
        }
      ],
      "ReqSecField": [
        {
          "EntryId": 1,
          "ReqSecField": 1
        }
      ],
      "RequireField": [
        {
          "EntryId": 1,
          "RequireField": 1
        }
      ],
      "RevSecField": [
        {
          "EntryId": 1,
          "RevSecField": 1
        }
      ],
      "RecordSelection": 1
    }
  ],
  "Token": "text"
}

updateSecFieldByID

post

Update security fields by ID

Authorizations

Body

SecFieldRecordSelectionintegerOptional

Responses

200

Successful operation.

application/json

post

/updateSecFieldByID

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SecFieldRecordSelection": 1,
  "SecFieldUpdatableFields": {
    "CreSecField": [
      {
        "EntryId": 1,
        "CreSecField": 1
      }
    ],
    "ReqSecField": [
      {
        "EntryId": 1,
        "ReqSecField": 1
      }
    ],
    "RequireField": [
      {
        "EntryId": 1,
        "RequireField": 1
      }
    ],
    "RevSecField": [
      {
        "EntryId": 1,
        "RevSecField": 1
      }
    ]
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

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

PreviousScreenDefinition NextSecurity

Last updated 1 year ago

Was this helpful?