ItcInstallation

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getItcInstallation

post

No description provided.

Authorizations
Body
ItcInstallationItcInstallationintegerRequired
Responses
200

Successful operation.

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

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

Successful operation.

{
  "ItcInstallation": {
    "DefinedCode": 1,
    "ItcEnabled": true,
    "ItcInstallation": 1,
    "TargetPath": "text",
    "TimeOutinMinutes": 1,
    "VoidEnabled": true
  }
}

getItcInstallationSelectFields

post

No description provided.

Authorizations
Body
ItcInstallationItcInstallationintegerOptional
Responses
200

Successful operation.

application/json
post
/getItcInstallationSelectFields
POST /nexum/627/2022.01/parameter/getItcInstallationSelectFields 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&"
    }
  },
  "ItcInstallationItcInstallation": 1,
  "SelectableFields": {
    "IncludeAllItcInstallationFields": true,
    "ItcInstallationFields": {
      "DefinedCode": true,
      "ItcEnabled": true,
      "ItcInstallation": true,
      "TargetPath": true,
      "TimeOutinMinutes": true,
      "VoidEnabled": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ItcInstallation": {
    "DefinedCode": 1,
    "ItcEnabled": true,
    "ItcInstallation": 1,
    "TargetPath": "text",
    "TimeOutinMinutes": 1,
    "VoidEnabled": true
  }
}

getItcInstallationPagedList

post

No description provided.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "ItcInstallation": [
    {
      "DefinedCode": 1,
      "ItcEnabled": true,
      "ItcInstallation": 1,
      "TargetPath": "text",
      "TimeOutinMinutes": 1,
      "VoidEnabled": true
    }
  ],
  "Token": "text"
}

getItcInstallationListSelectFields

post

No description provided.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllItcInstallationFields": true,
    "ItcInstallationFields": {
      "DefinedCode": true,
      "ItcEnabled": true,
      "ItcInstallation": true,
      "TargetPath": true,
      "TimeOutinMinutes": true,
      "VoidEnabled": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ItcInstallationList": {
    "hasReachedMaximumListSize": true,
    "ItcInstallation": [
      {
        "DefinedCode": 1,
        "ItcEnabled": true,
        "ItcInstallation": 1,
        "TargetPath": "text",
        "TimeOutinMinutes": 1,
        "VoidEnabled": true
      }
    ]
  }
}

searchItcInstallationSelectFields

post

Retrieve a list of select fields for searching by ITC installation information.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllItcInstallationFields": true,
    "ItcInstallationFields": {
      "DefinedCode": true,
      "ItcEnabled": true,
      "ItcInstallation": true,
      "TargetPath": true,
      "TimeOutinMinutes": true,
      "VoidEnabled": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ItcInstallationList": {
    "hasReachedMaximumListSize": true,
    "ItcInstallation": [
      {
        "DefinedCode": 1,
        "ItcEnabled": true,
        "ItcInstallation": 1,
        "TargetPath": "text",
        "TimeOutinMinutes": 1,
        "VoidEnabled": true
      }
    ]
  }
}

getItcInstallationPagedListSelectFields

post

No description provided.

Authorizations
Body
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllItcInstallationFields": true,
    "ItcInstallationFields": {
      "DefinedCode": true,
      "ItcEnabled": true,
      "ItcInstallation": true,
      "TargetPath": true,
      "TimeOutinMinutes": true,
      "VoidEnabled": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ItcInstallation": [
    {
      "DefinedCode": 1,
      "ItcEnabled": true,
      "ItcInstallation": 1,
      "TargetPath": "text",
      "TimeOutinMinutes": 1,
      "VoidEnabled": true
    }
  ],
  "Token": "text"
}

searchItcInstallationPagedSelectFields

post

Retrieve a list of paged select fields for searching by ITC installation information.

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllItcInstallationFields": true,
    "ItcInstallationFields": {
      "DefinedCode": true,
      "ItcEnabled": true,
      "ItcInstallation": true,
      "TargetPath": true,
      "TimeOutinMinutes": true,
      "VoidEnabled": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "ItcInstallation": [
    {
      "DefinedCode": 1,
      "ItcEnabled": true,
      "ItcInstallation": 1,
      "TargetPath": "text",
      "TimeOutinMinutes": 1,
      "VoidEnabled": true
    }
  ],
  "Token": "text"
}

updateItcInstallationByID

post
Authorizations
Body
ItcInstallationItcInstallationintegerOptional
Responses
200

Successful operation.

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "ItcInstallationItcInstallation": 1,
  "ItcInstallationUpdatableFields": {
    "DefinedCode": 1,
    "ItcEnabled": true,
    "TargetPath": "text",
    "TimeOutinMinutes": 1,
    "VoidEnabled": true
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?