AccountFieldName

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getAccountFieldName

post

Retrieve the field name for the account

Authorizations
Body
AccountFieldNameFieldintegerRequired
Responses
200

Successful operation.

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

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

Successful operation.

{
  "AccountFieldName": {
    "Field": 1,
    "FieldName": "text"
  }
}

getAccountFieldNameSelectFields

post

Retrieve field names for accounts with selected fields

Authorizations
Body
AccountFieldNameFieldintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountFieldNameField": 1,
  "SelectableFields": {
    "IncludeAllAccountFieldNameFields": true,
    "AccountFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "AccountFieldName": {
    "Field": 1,
    "FieldName": "text"
  }
}

getAccountFieldNamePagedList

post

Retrieve a paged list of field names for accounts

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getAccountFieldNamePagedList
POST /nexum/627/2022.01/parameter/getAccountFieldNamePagedList 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.

{
  "AccountFieldName": [
    {
      "Field": 1,
      "FieldName": "text"
    }
  ],
  "Token": "text"
}

getAccountFieldNameListSelectFields

post

Retrieve the list of field names with selectable fields for accounts

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllAccountFieldNameFields": true,
    "AccountFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "AccountFieldNameList": {
    "hasReachedMaximumListSize": true,
    "AccountFieldName": [
      {
        "Field": 1,
        "FieldName": "text"
      }
    ]
  }
}

searchAccountFieldNameSelectFields

post

Search account field name select fields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllAccountFieldNameFields": true,
    "AccountFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "AccountFieldNameList": {
    "hasReachedMaximumListSize": true,
    "AccountFieldName": [
      {
        "Field": 1,
        "FieldName": "text"
      }
    ]
  }
}

getAccountFieldNamePagedListSelectFields

post

Retrieve a paged list of field names for accounts with selected fields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllAccountFieldNameFields": true,
    "AccountFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "AccountFieldName": [
    {
      "Field": 1,
      "FieldName": "text"
    }
  ],
  "Token": "text"
}

searchAccountFieldNamePagedSelectFields

post

Search account field name paged select fields

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllAccountFieldNameFields": true,
    "AccountFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "AccountFieldName": [
    {
      "Field": 1,
      "FieldName": "text"
    }
  ],
  "Token": "text"
}

updateAccountFieldNameByID

post

Update Account Field Name by ID

Authorizations
Body
AccountFieldNameFieldintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "AccountFieldNameField": 1,
  "AccountFieldNameUpdatableFields": {
    "FieldName": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?