Comment

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getComment

post

Retrieve a comment.

Authorizations
Body
CommentCommentTypeintegerOptional
CommentCommentintegerOptional
Responses
200

Successful operation.

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

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

Successful operation.

{
  "Comment": {
    "Comment": 1,
    "CommentType": 1,
    "DataType": [
      {
        "EntryId": 1,
        "DataType": 1
      }
    ],
    "DefaultChar": [
      {
        "EntryId": 1,
        "DefaultChar": "text"
      }
    ],
    "DefaultNum": [
      {
        "EntryId": 1,
        "DefaultNum": 1
      }
    ],
    "Description": "text",
    "Format": 1,
    "KeyCodePurpose": "text",
    "Line": [
      {
        "EntryId": 1,
        "Line": "text"
      }
    ],
    "Line1": [
      {
        "EntryId": 1,
        "Line1": "text"
      }
    ],
    "Line2": [
      {
        "EntryId": 1,
        "Line2": "text"
      }
    ],
    "MaxCode": [
      {
        "EntryId": 1,
        "MaxCode": 1
      }
    ],
    "MaxLength": [
      {
        "EntryId": 1,
        "MaxLength": 1
      }
    ],
    "MemberBillingCode": "text",
    "NonMemberBillingCode": "text",
    "Prompt": [
      {
        "EntryId": 1,
        "Prompt": "text"
      }
    ],
    "ReportingCode": "text",
    "ReportingDescription": "text",
    "Status": 1,
    "UserHelp": [
      {
        "EntryId": 1,
        "UserHelp": 1
      }
    ]
  }
}

getCommentSelectFields

post

Retrieve select fields for a specific comment.

Authorizations
Body
CommentCommentTypeintegerOptional
CommentCommentintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CommentCommentType": 1,
  "CommentComment": 1,
  "SelectableFields": {
    "IncludeAllCommentFields": true,
    "CommentFields": {
      "Comment": true,
      "CommentType": true,
      "DataType": [
        1
      ],
      "DefaultChar": [
        1
      ],
      "DefaultNum": [
        1
      ],
      "Description": true,
      "Format": true,
      "KeyCodePurpose": true,
      "Line": [
        1
      ],
      "Line1": [
        1
      ],
      "Line2": [
        1
      ],
      "MaxCode": [
        1
      ],
      "MaxLength": [
        1
      ],
      "MemberBillingCode": true,
      "NonMemberBillingCode": true,
      "Prompt": [
        1
      ],
      "ReportingCode": true,
      "ReportingDescription": true,
      "Status": true,
      "UserHelp": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Comment": {
    "Comment": 1,
    "CommentType": 1,
    "DataType": [
      {
        "EntryId": 1,
        "DataType": 1
      }
    ],
    "DefaultChar": [
      {
        "EntryId": 1,
        "DefaultChar": "text"
      }
    ],
    "DefaultNum": [
      {
        "EntryId": 1,
        "DefaultNum": 1
      }
    ],
    "Description": "text",
    "Format": 1,
    "KeyCodePurpose": "text",
    "Line": [
      {
        "EntryId": 1,
        "Line": "text"
      }
    ],
    "Line1": [
      {
        "EntryId": 1,
        "Line1": "text"
      }
    ],
    "Line2": [
      {
        "EntryId": 1,
        "Line2": "text"
      }
    ],
    "MaxCode": [
      {
        "EntryId": 1,
        "MaxCode": 1
      }
    ],
    "MaxLength": [
      {
        "EntryId": 1,
        "MaxLength": 1
      }
    ],
    "MemberBillingCode": "text",
    "NonMemberBillingCode": "text",
    "Prompt": [
      {
        "EntryId": 1,
        "Prompt": "text"
      }
    ],
    "ReportingCode": "text",
    "ReportingDescription": "text",
    "Status": 1,
    "UserHelp": [
      {
        "EntryId": 1,
        "UserHelp": 1
      }
    ]
  }
}

getCommentPagedList

post

Retrieve comments in a paged list.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Comment": [
    {
      "Comment": 1,
      "CommentType": 1,
      "DataType": [
        {
          "EntryId": 1,
          "DataType": 1
        }
      ],
      "DefaultChar": [
        {
          "EntryId": 1,
          "DefaultChar": "text"
        }
      ],
      "DefaultNum": [
        {
          "EntryId": 1,
          "DefaultNum": 1
        }
      ],
      "Description": "text",
      "Format": 1,
      "KeyCodePurpose": "text",
      "Line": [
        {
          "EntryId": 1,
          "Line": "text"
        }
      ],
      "Line1": [
        {
          "EntryId": 1,
          "Line1": "text"
        }
      ],
      "Line2": [
        {
          "EntryId": 1,
          "Line2": "text"
        }
      ],
      "MaxCode": [
        {
          "EntryId": 1,
          "MaxCode": 1
        }
      ],
      "MaxLength": [
        {
          "EntryId": 1,
          "MaxLength": 1
        }
      ],
      "MemberBillingCode": "text",
      "NonMemberBillingCode": "text",
      "Prompt": [
        {
          "EntryId": 1,
          "Prompt": "text"
        }
      ],
      "ReportingCode": "text",
      "ReportingDescription": "text",
      "Status": 1,
      "UserHelp": [
        {
          "EntryId": 1,
          "UserHelp": 1
        }
      ]
    }
  ],
  "Token": "text"
}

getCommentListSelectFields

post

Retrieve a list of select fields for comments.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllCommentFields": true,
    "CommentFields": {
      "Comment": true,
      "CommentType": true,
      "DataType": [
        1
      ],
      "DefaultChar": [
        1
      ],
      "DefaultNum": [
        1
      ],
      "Description": true,
      "Format": true,
      "KeyCodePurpose": true,
      "Line": [
        1
      ],
      "Line1": [
        1
      ],
      "Line2": [
        1
      ],
      "MaxCode": [
        1
      ],
      "MaxLength": [
        1
      ],
      "MemberBillingCode": true,
      "NonMemberBillingCode": true,
      "Prompt": [
        1
      ],
      "ReportingCode": true,
      "ReportingDescription": true,
      "Status": true,
      "UserHelp": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "CommentList": {
    "hasReachedMaximumListSize": true,
    "Comment": [
      {
        "Comment": 1,
        "CommentType": 1,
        "DataType": [
          {
            "EntryId": 1,
            "DataType": 1
          }
        ],
        "DefaultChar": [
          {
            "EntryId": 1,
            "DefaultChar": "text"
          }
        ],
        "DefaultNum": [
          {
            "EntryId": 1,
            "DefaultNum": 1
          }
        ],
        "Description": "text",
        "Format": 1,
        "KeyCodePurpose": "text",
        "Line": [
          {
            "EntryId": 1,
            "Line": "text"
          }
        ],
        "Line1": [
          {
            "EntryId": 1,
            "Line1": "text"
          }
        ],
        "Line2": [
          {
            "EntryId": 1,
            "Line2": "text"
          }
        ],
        "MaxCode": [
          {
            "EntryId": 1,
            "MaxCode": 1
          }
        ],
        "MaxLength": [
          {
            "EntryId": 1,
            "MaxLength": 1
          }
        ],
        "MemberBillingCode": "text",
        "NonMemberBillingCode": "text",
        "Prompt": [
          {
            "EntryId": 1,
            "Prompt": "text"
          }
        ],
        "ReportingCode": "text",
        "ReportingDescription": "text",
        "Status": 1,
        "UserHelp": [
          {
            "EntryId": 1,
            "UserHelp": 1
          }
        ]
      }
    ]
  }
}

searchCommentSelectFields

post

Field for selecting various options related to searchcommentselectfields

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllCommentFields": true,
    "CommentFields": {
      "Comment": true,
      "CommentType": true,
      "DataType": [
        1
      ],
      "DefaultChar": [
        1
      ],
      "DefaultNum": [
        1
      ],
      "Description": true,
      "Format": true,
      "KeyCodePurpose": true,
      "Line": [
        1
      ],
      "Line1": [
        1
      ],
      "Line2": [
        1
      ],
      "MaxCode": [
        1
      ],
      "MaxLength": [
        1
      ],
      "MemberBillingCode": true,
      "NonMemberBillingCode": true,
      "Prompt": [
        1
      ],
      "ReportingCode": true,
      "ReportingDescription": true,
      "Status": true,
      "UserHelp": [
        1
      ]
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "CommentList": {
    "hasReachedMaximumListSize": true,
    "Comment": [
      {
        "Comment": 1,
        "CommentType": 1,
        "DataType": [
          {
            "EntryId": 1,
            "DataType": 1
          }
        ],
        "DefaultChar": [
          {
            "EntryId": 1,
            "DefaultChar": "text"
          }
        ],
        "DefaultNum": [
          {
            "EntryId": 1,
            "DefaultNum": 1
          }
        ],
        "Description": "text",
        "Format": 1,
        "KeyCodePurpose": "text",
        "Line": [
          {
            "EntryId": 1,
            "Line": "text"
          }
        ],
        "Line1": [
          {
            "EntryId": 1,
            "Line1": "text"
          }
        ],
        "Line2": [
          {
            "EntryId": 1,
            "Line2": "text"
          }
        ],
        "MaxCode": [
          {
            "EntryId": 1,
            "MaxCode": 1
          }
        ],
        "MaxLength": [
          {
            "EntryId": 1,
            "MaxLength": 1
          }
        ],
        "MemberBillingCode": "text",
        "NonMemberBillingCode": "text",
        "Prompt": [
          {
            "EntryId": 1,
            "Prompt": "text"
          }
        ],
        "ReportingCode": "text",
        "ReportingDescription": "text",
        "Status": 1,
        "UserHelp": [
          {
            "EntryId": 1,
            "UserHelp": 1
          }
        ]
      }
    ]
  }
}

getCommentPagedListSelectFields

post

Retrieve a paged list of select fields for comments.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCommentFields": true,
    "CommentFields": {
      "Comment": true,
      "CommentType": true,
      "DataType": [
        1
      ],
      "DefaultChar": [
        1
      ],
      "DefaultNum": [
        1
      ],
      "Description": true,
      "Format": true,
      "KeyCodePurpose": true,
      "Line": [
        1
      ],
      "Line1": [
        1
      ],
      "Line2": [
        1
      ],
      "MaxCode": [
        1
      ],
      "MaxLength": [
        1
      ],
      "MemberBillingCode": true,
      "NonMemberBillingCode": true,
      "Prompt": [
        1
      ],
      "ReportingCode": true,
      "ReportingDescription": true,
      "Status": true,
      "UserHelp": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Comment": [
    {
      "Comment": 1,
      "CommentType": 1,
      "DataType": [
        {
          "EntryId": 1,
          "DataType": 1
        }
      ],
      "DefaultChar": [
        {
          "EntryId": 1,
          "DefaultChar": "text"
        }
      ],
      "DefaultNum": [
        {
          "EntryId": 1,
          "DefaultNum": 1
        }
      ],
      "Description": "text",
      "Format": 1,
      "KeyCodePurpose": "text",
      "Line": [
        {
          "EntryId": 1,
          "Line": "text"
        }
      ],
      "Line1": [
        {
          "EntryId": 1,
          "Line1": "text"
        }
      ],
      "Line2": [
        {
          "EntryId": 1,
          "Line2": "text"
        }
      ],
      "MaxCode": [
        {
          "EntryId": 1,
          "MaxCode": 1
        }
      ],
      "MaxLength": [
        {
          "EntryId": 1,
          "MaxLength": 1
        }
      ],
      "MemberBillingCode": "text",
      "NonMemberBillingCode": "text",
      "Prompt": [
        {
          "EntryId": 1,
          "Prompt": "text"
        }
      ],
      "ReportingCode": "text",
      "ReportingDescription": "text",
      "Status": 1,
      "UserHelp": [
        {
          "EntryId": 1,
          "UserHelp": 1
        }
      ]
    }
  ],
  "Token": "text"
}

searchCommentPagedSelectFields

post

Field for selecting various options related to searchcommentpagedselectfields

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllCommentFields": true,
    "CommentFields": {
      "Comment": true,
      "CommentType": true,
      "DataType": [
        1
      ],
      "DefaultChar": [
        1
      ],
      "DefaultNum": [
        1
      ],
      "Description": true,
      "Format": true,
      "KeyCodePurpose": true,
      "Line": [
        1
      ],
      "Line1": [
        1
      ],
      "Line2": [
        1
      ],
      "MaxCode": [
        1
      ],
      "MaxLength": [
        1
      ],
      "MemberBillingCode": true,
      "NonMemberBillingCode": true,
      "Prompt": [
        1
      ],
      "ReportingCode": true,
      "ReportingDescription": true,
      "Status": true,
      "UserHelp": [
        1
      ]
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "Comment": [
    {
      "Comment": 1,
      "CommentType": 1,
      "DataType": [
        {
          "EntryId": 1,
          "DataType": 1
        }
      ],
      "DefaultChar": [
        {
          "EntryId": 1,
          "DefaultChar": "text"
        }
      ],
      "DefaultNum": [
        {
          "EntryId": 1,
          "DefaultNum": 1
        }
      ],
      "Description": "text",
      "Format": 1,
      "KeyCodePurpose": "text",
      "Line": [
        {
          "EntryId": 1,
          "Line": "text"
        }
      ],
      "Line1": [
        {
          "EntryId": 1,
          "Line1": "text"
        }
      ],
      "Line2": [
        {
          "EntryId": 1,
          "Line2": "text"
        }
      ],
      "MaxCode": [
        {
          "EntryId": 1,
          "MaxCode": 1
        }
      ],
      "MaxLength": [
        {
          "EntryId": 1,
          "MaxLength": 1
        }
      ],
      "MemberBillingCode": "text",
      "NonMemberBillingCode": "text",
      "Prompt": [
        {
          "EntryId": 1,
          "Prompt": "text"
        }
      ],
      "ReportingCode": "text",
      "ReportingDescription": "text",
      "Status": 1,
      "UserHelp": [
        {
          "EntryId": 1,
          "UserHelp": 1
        }
      ]
    }
  ],
  "Token": "text"
}

updateCommentByID

post

Update Comment by ID

Authorizations
Body
CommentCommentTypeintegerOptional
CommentCommentintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "CommentCommentType": 1,
  "CommentComment": 1,
  "CommentUpdatableFields": {
    "DataType": [
      {
        "EntryId": 1,
        "DataType": 1
      }
    ],
    "DefaultChar": [
      {
        "EntryId": 1,
        "DefaultChar": "text"
      }
    ],
    "DefaultNum": [
      {
        "EntryId": 1,
        "DefaultNum": 1
      }
    ],
    "Description": "text",
    "Format": 1,
    "KeyCodePurpose": "text",
    "Line": [
      {
        "EntryId": 1,
        "Line": "text"
      }
    ],
    "Line1": [
      {
        "EntryId": 1,
        "Line1": "text"
      }
    ],
    "Line2": [
      {
        "EntryId": 1,
        "Line2": "text"
      }
    ],
    "MaxCode": [
      {
        "EntryId": 1,
        "MaxCode": 1
      }
    ],
    "MaxLength": [
      {
        "EntryId": 1,
        "MaxLength": 1
      }
    ],
    "MemberBillingCode": "text",
    "NonMemberBillingCode": "text",
    "Prompt": [
      {
        "EntryId": 1,
        "Prompt": "text"
      }
    ],
    "ReportingCode": "text",
    "ReportingDescription": "text",
    "Status": 1,
    "UserHelp": [
      {
        "EntryId": 1,
        "UserHelp": 1
      }
    ]
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?