InventoryCopiedFlds

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getInventoryCopiedFlds

post

Retrieve InventoryCopiedFlds parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

InventoryCopiedFldsInventoryScreenTypeintegerRequired

Responses

200

Successful operation.

application/json

post/getInventoryCopiedFlds

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "InventoryCopiedFldsInventoryScreenType": 1,
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "InventoryCopiedFlds": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getInventoryCopiedFlds"
}

getInventoryCopiedFldsSelectFields

post

Retrieve InventoryCopiedFlds parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

InventoryCopiedFldsInventoryScreenTypeintegerOptional

Responses

200

Successful operation.

application/json

post/getInventoryCopiedFldsSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "InventoryCopiedFldsInventoryScreenType": 0,
  "SelectableFields": {
    "InventoryCopiedFldsFields": {
      "InventoryScreenType": true,
      "CopiedField": [
        1
      ],
      "SubField": [
        1
      ]
    }
  }
}

200

Successful operation.

{
  "InventoryCopiedFlds": {
    "CopiedField": [
      {
        "EntryId": 1,
        "CopiedField": 0
      }
    ],
    "InventoryScreenType": 0,
    "SubField": [
      {
        "EntryId": 1,
        "SubField": 0
      }
    ]
  },
  "MessageId": "getInventoryCopiedFldsSelectFields"
}

getInventoryCopiedFldsPagedList

post

Retrieve InventoryCopiedFlds parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getInventoryCopiedFldsPagedList

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 5,
    "NumberOfRecordsToSkip": 0,
    "Token": "example-token"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "InventoryCopiedFlds": [],
  "Token": null,
  "MessageId": "getInventoryCopiedFldsPagedList"
}

getInventoryCopiedFldsListSelectFields

post

Retrieve InventoryCopiedFlds parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/getInventoryCopiedFldsListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "SelectableFields": {
    "IncludeAllInventoryCopiedFldsFields": true
  }
}

200

Successful operation.

{
  "InventoryCopiedFldsList": [],
  "MessageId": "getInventoryCopiedFldsListSelectFields"
}

searchInventoryCopiedFldsSelectFields

post

Search InventoryCopiedFlds parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post/searchInventoryCopiedFldsSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "SelectableFields": {
    "IncludeAllInventoryCopiedFldsFields": true
  },
  "SearchFilter": {
    "Query": "example-query"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "InventoryCopiedFldsList": [],
  "MessageId": "searchInventoryCopiedFldsSelectFields"
}

getInventoryCopiedFldsPagedListSelectFields

post

Retrieve InventoryCopiedFlds parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

TokenstringOptional

post/getInventoryCopiedFldsPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "InventoryCopiedFldsFields": {
      "InventoryScreenType": true,
      "CopiedField": [
        1
      ],
      "SubField": [
        1
      ]
    }
  }
}

200

Successful operation.

{
  "InventoryCopiedFlds": [
    {
      "CopiedField": [
        {
          "EntryId": 1,
          "CopiedField": 0
        }
      ],
      "InventoryScreenType": 0,
      "SubField": [
        {
          "EntryId": 1,
          "SubField": 0
        }
      ]
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getInventoryCopiedFldsPagedListSelectFields"
}

searchInventoryCopiedFldsPagedSelectFields

post

Search InventoryCopiedFlds parameter records. ParameterService is available for SymXchange 2022.01 in this documentation set.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

QuerystringOptional

Responses

200

Successful operation.

application/json

TokenstringOptional

post/searchInventoryCopiedFldsPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "InventoryCopiedFldsFields": {
      "InventoryScreenType": true,
      "CopiedField": [
        1
      ],
      "SubField": [
        1
      ]
    }
  }
}

200

Successful operation.

{
  "InventoryCopiedFlds": [
    {
      "CopiedField": [
        {
          "EntryId": 1,
          "CopiedField": 0
        }
      ],
      "InventoryScreenType": 0,
      "SubField": [
        {
          "EntryId": 1,
          "SubField": 0
        }
      ]
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchInventoryCopiedFldsPagedSelectFields"
}

updateInventoryCopiedFldsByID

post

Update InventoryCopiedFlds parameter configuration. Parameter updates can change institution behavior and should be tested in a controlled environment before use.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

InventoryCopiedFldsInventoryScreenTypeintegerOptional

Responses

200

Successful operation.

application/json

post/updateInventoryCopiedFldsByID

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "InventoryCopiedFldsInventoryScreenType": 1,
  "InventoryCopiedFldsUpdatableFields": {
    "Type": 0,
    "Description": "NEXUM EXAMPLE"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "{application-id}"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": []
  },
  "MessageId": "updateInventoryCopiedFldsByID"
}