WorkFlowRepGen

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getWorkFlowRepGen

post

Retrieve WorkFlowRepGen 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

WorkFlowRepGenSpecfileintegerRequired

Responses

200

Successful operation.

application/json

post/getWorkFlowRepGen

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "WorkFlowRepGen": {
    "RecordChangeDate": "2010-05-08"
  },
  "MessageId": "getWorkFlowRepGen"
}

getWorkFlowRepGenSelectFields

post

Retrieve WorkFlowRepGen 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

WorkFlowRepGenSpecfileintegerOptional

Responses

200

Successful operation.

application/json

post/getWorkFlowRepGenSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "WorkFlowRepGenSpecfile": 99,
  "SelectableFields": {
    "WorkFlowRepGenFields": {
      "Specfile": true,
      "SpecfileName": true,
      "SpecfileDescription": true
    }
  }
}

200

Successful operation.

{
  "WorkFlowRepGen": {
    "Specfile": 99,
    "SpecfileDescription": "Work Flow Specfile 99",
    "SpecfileName": null
  },
  "MessageId": "getWorkFlowRepGenSelectFields"
}

getWorkFlowRepGenPagedList

post

Retrieve WorkFlowRepGen 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/getWorkFlowRepGenPagedList

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getWorkFlowRepGenPagedList 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.

{
  "WorkFlowRepGen": [],
  "Token": null,
  "MessageId": "getWorkFlowRepGenPagedList"
}

getWorkFlowRepGenListSelectFields

post

Retrieve WorkFlowRepGen 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/getWorkFlowRepGenListSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "WorkFlowRepGenList": [],
  "MessageId": "getWorkFlowRepGenListSelectFields"
}

searchWorkFlowRepGenSelectFields

post

Search WorkFlowRepGen 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/searchWorkFlowRepGenSelectFields

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

{
  "WorkFlowRepGenList": [],
  "MessageId": "searchWorkFlowRepGenSelectFields"
}

getWorkFlowRepGenPagedListSelectFields

post

Retrieve WorkFlowRepGen 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/getWorkFlowRepGenPagedListSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "SelectableFields": {
    "WorkFlowRepGenFields": {
      "Specfile": true,
      "SpecfileName": true,
      "SpecfileDescription": true
    }
  }
}

200

Successful operation.

{
  "WorkFlowRepGen": [
    {
      "Specfile": 99,
      "SpecfileDescription": "Work Flow Specfile 00",
      "SpecfileName": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "getWorkFlowRepGenPagedListSelectFields"
}

searchWorkFlowRepGenPagedSelectFields

post

Search WorkFlowRepGen 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/searchWorkFlowRepGenPagedSelectFields

HTTPcURLJavaScriptPython

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

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": {
        "symx-administrative-password": null
      }
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "parameter-reference"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 0
  },
  "Query": "",
  "SelectableFields": {
    "WorkFlowRepGenFields": {
      "Specfile": true,
      "SpecfileName": true,
      "SpecfileDescription": true
    }
  }
}

200

Successful operation.

{
  "WorkFlowRepGen": [
    {
      "Specfile": 99,
      "SpecfileDescription": "Work Flow Specfile 00",
      "SpecfileName": null
    }
  ],
  "Token": "{paging-token}",
  "MessageId": "searchWorkFlowRepGenPagedSelectFields"
}

updateWorkFlowRepGenByID

post

Update WorkFlowRepGen 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

WorkFlowRepGenSpecfileintegerOptional

Responses

200

Successful operation.

application/json

post/updateWorkFlowRepGenByID

HTTPcURLJavaScriptPython

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

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

200

Successful operation.

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