WorkFlowRepGen

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getWorkFlowRepGen

post

Get workflow report generation

Authorizations
Body
WorkFlowRepGenSpecfileintegerRequired
Responses
200

Successful operation.

application/json
post
/getWorkFlowRepGen
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: 151

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

Successful operation.

{
  "WorkFlowRepGen": {
    "Specfile": 1,
    "SpecfileDescription": "text",
    "SpecfileName": "text"
  }
}

getWorkFlowRepGenSelectFields

post

Get workflow report generation select fields

Authorizations
Body
WorkFlowRepGenSpecfileintegerOptional
Responses
200

Successful operation.

application/json
post
/getWorkFlowRepGenSelectFields
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: 298

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WorkFlowRepGenSpecfile": 1,
  "SelectableFields": {
    "IncludeAllWorkFlowRepGenFields": true,
    "WorkFlowRepGenFields": {
      "Specfile": true,
      "SpecfileDescription": true,
      "SpecfileName": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "WorkFlowRepGen": {
    "Specfile": 1,
    "SpecfileDescription": "text",
    "SpecfileName": "text"
  }
}

getWorkFlowRepGenPagedList

post

Get workflow report generation paged list

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getWorkFlowRepGenPagedList
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: 218

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "WorkFlowRepGen": [
    {
      "Specfile": 1,
      "SpecfileDescription": "text",
      "SpecfileName": "text"
    }
  ],
  "Token": "text"
}

getWorkFlowRepGenListSelectFields

post

Get workflow report generation list select fields

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getWorkFlowRepGenListSelectFields
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: 271

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllWorkFlowRepGenFields": true,
    "WorkFlowRepGenFields": {
      "Specfile": true,
      "SpecfileDescription": true,
      "SpecfileName": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "WorkFlowRepGenList": {
    "hasReachedMaximumListSize": true,
    "WorkFlowRepGen": [
      {
        "Specfile": 1,
        "SpecfileDescription": "text",
        "SpecfileName": "text"
      }
    ]
  }
}

searchWorkFlowRepGenSelectFields

post

Fields available for selecting when retrieving Workflow Report Generation data

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/searchWorkFlowRepGenSelectFields
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: 303

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllWorkFlowRepGenFields": true,
    "WorkFlowRepGenFields": {
      "Specfile": true,
      "SpecfileDescription": true,
      "SpecfileName": true
    }
  },
  "SearchFilter": {
    "Query": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "WorkFlowRepGenList": {
    "hasReachedMaximumListSize": true,
    "WorkFlowRepGen": [
      {
        "Specfile": 1,
        "SpecfileDescription": "text",
        "SpecfileName": "text"
      }
    ]
  }
}

getWorkFlowRepGenPagedListSelectFields

post

Get workflow report generation paged list select fields

Authorizations
Body
Responses
200

Successful operation.

application/json
post
/getWorkFlowRepGenPagedListSelectFields
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: 365

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllWorkFlowRepGenFields": true,
    "WorkFlowRepGenFields": {
      "Specfile": true,
      "SpecfileDescription": true,
      "SpecfileName": true
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "WorkFlowRepGen": [
    {
      "Specfile": 1,
      "SpecfileDescription": "text",
      "SpecfileName": "text"
    }
  ],
  "Token": "text"
}

searchWorkFlowRepGenPagedSelectFields

post

Fields available for selecting when retrieving paginated Workflow Report Generation data

Authorizations
Body
QuerystringOptional
Responses
200

Successful operation.

application/json
post
/searchWorkFlowRepGenPagedSelectFields
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: 380

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "PagingRequestContext": {
    "NumberOfRecordsToReturn": 1,
    "NumberOfRecordsToSkip": 1,
    "Token": "text"
  },
  "SelectableFields": {
    "IncludeAllWorkFlowRepGenFields": true,
    "WorkFlowRepGenFields": {
      "Specfile": true,
      "SpecfileDescription": true,
      "SpecfileName": true
    }
  },
  "Query": "text",
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

{
  "WorkFlowRepGen": [
    {
      "Specfile": 1,
      "SpecfileDescription": "text",
      "SpecfileName": "text"
    }
  ],
  "Token": "text"
}

updateWorkFlowRepGenByID

post

Update Workflow Report Generation for a specific ID.

Authorizations
Body
WorkFlowRepGenSpecfileintegerOptional
Responses
200

Successful operation.

application/json
post
/updateWorkFlowRepGenByID
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: 236

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "WorkFlowRepGenSpecfile": 1,
  "WorkFlowRepGenUpdatableFields": {
    "SpecfileDescription": "text",
    "SpecfileName": "text"
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}
200

Successful operation.

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

Last updated

Was this helpful?