ShareFieldName

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getShareFieldName

post

Retrieve share field name

Authorizations
Body
ShareFieldNameFieldintegerRequired
Responses
200

Successful operation.

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

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

Successful operation.

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

getShareFieldNameSelectFields

post

Retrieve getShareFieldNameSelectFields data.

Authorizations
Body
ShareFieldNameFieldintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ShareFieldNameField": 1,
  "SelectableFields": {
    "IncludeAllShareFieldNameFields": true,
    "ShareFieldNameFields": {
      "Field": true,
      "FieldName": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

getShareFieldNamePagedList

post

Returns paged list of share field names

Authorizations
Body
Responses
200

Successful operation.

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

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

getShareFieldNameListSelectFields

post

Returns the list of share field names with select fields

Authorizations
Body
Responses
200

Successful operation.

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

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

Successful operation.

{
  "ShareFieldNameList": {
    "hasReachedMaximumListSize": true,
    "ShareFieldName": [
      {
        "Field": 1,
        "FieldName": "text"
      }
    ]
  }
}

searchShareFieldNameSelectFields

post

Retrieve a list of select fields for share field names

Authorizations
Body
Responses
200

Successful operation.

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

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

Successful operation.

{
  "ShareFieldNameList": {
    "hasReachedMaximumListSize": true,
    "ShareFieldName": [
      {
        "Field": 1,
        "FieldName": "text"
      }
    ]
  }
}

getShareFieldNamePagedListSelectFields

post

Returns paged list of share field names with select fields

Authorizations
Body
Responses
200

Successful operation.

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

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

Successful operation.

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

searchShareFieldNamePagedSelectFields

post

Retrieve a paged list of select fields for share field names

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

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

Successful operation.

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

updateShareFieldNameByID

post

Update share field names by ID

Authorizations
Body
ShareFieldNameFieldintegerOptional
Responses
200

Successful operation.

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

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

Successful operation.

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

Last updated

Was this helpful?