NameFieldName

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getNameFieldName

post

Retrieve name field name

Authorizations
Body
NameFieldNameFieldintegerRequired
Responses
200

Successful operation.

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

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

Successful operation.

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

getNameFieldNameSelectFields

post

Retrieve name field name select fields

Authorizations
Body
NameFieldNameFieldintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "NameFieldNameField": 1,
  "SelectableFields": {
    "IncludeAllNameFieldNameFields": true,
    "NameFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

getNameFieldNamePagedList

post

Retrieve paged list of name field names

Authorizations
Body
Responses
200

Successful operation.

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

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

getNameFieldNameListSelectFields

post

Retrieve name field name list select fields

Authorizations
Body
Responses
200

Successful operation.

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

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

Successful operation.

{
  "NameFieldNameList": {
    "hasReachedMaximumListSize": true,
    "NameFieldName": [
      {
        "Field": 1,
        "FieldName": "text"
      }
    ]
  }
}

searchNameFieldNameSelectFields

post

Retrieve a list of select fields for searching by name field names.

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/searchNameFieldNameSelectFields
POST /nexum/627/2022.01/parameter/searchNameFieldNameSelectFields 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&"
    }
  },
  "SelectableFields": {
    "IncludeAllNameFieldNameFields": true,
    "NameFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "NameFieldNameList": {
    "hasReachedMaximumListSize": true,
    "NameFieldName": [
      {
        "Field": 1,
        "FieldName": "text"
      }
    ]
  }
}

getNameFieldNamePagedListSelectFields

post

Retrieve paged list select fields of name field names

Authorizations
Body
Responses
200

Successful operation.

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

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

Successful operation.

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

searchNameFieldNamePagedSelectFields

post

Retrieve a list of paged select fields for searching by name field names.

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

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

Successful operation.

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

updateNameFieldNameByID

post

Update name field names by ID

Authorizations
Body
NameFieldNameFieldintegerOptional
Responses
200

Successful operation.

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

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

Successful operation.

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

Last updated

Was this helpful?