Docs
Record Document Upload Service
Record Processes ServicesRecord Document Upload Service
METHODS
POST Record Add Composite Field Service
GET Record Assign Service
POST Record Document Upload Service
POST Record Save Service
GET Record Transition Service
POST Record Update Service
Record Document Upload Service

This method update specific record from document field data in request. Document field data must be base64. The client makes a POST request providing Request body in xml format and input parameters RecordID, Document Field Code, Language in the request url. The output will be xml format. Updated record ID will be return. All circumstances will be return Process Status Types and Process Message. System will be returned operation status of web service with “ProcessStatusTypes”. The status informations is given in the following descriptions.

Name Value
Service Type RESTFUL / POST
Request Data Type XML
Response Data Type XML
Content Type UTF-8
Authentication Types Basic Authentication, Custom Header Authenticaton
Sample Request Endpoint http://company.bpm.next4biz.com/RES/RecordProcessorService.svc/AddDocument/RecordID/{RecordID}/DocumentFieldCode/{DocumentFieldCode}/Language/{Turkish}

ProcessStatusTypes

  • Success
    • Process finished with success
  • NoEntryPageForWorkflow
    • Process finished with an error. The record does not occur. Workflow has no entry page (Workflow design issue).
  • NoWorkflow
    • Process finished with an error. The record does not occur. Service workflow parameter is missing or incorrect (Workflow design issue).
  • NoCurrentUser
    • Process finished with an error. The record does not occur. Service has no authorized user, or user has not authorized.
  • NoCategory
    • Process finished with an error. The record does not occur. Service category parameter is missing or incorrect
  • NullRecord
    • Process finished with an error. The record does not process. RecordID is missing or incorrect
  • InvalidAssignedUserForTakeownership
    • Process finished with an error. The record does not process. A processed user is missing or incorrect.
  • InvalidAssignedUserGroupForTakeownership
    • Process finished with an error. The record does not process. The processed user group is missing or incorrect.
  • EmptyNoteList
    • Process finished with an error. The record does not process. The record has no notes.
  • InvalidNote
    • Process finished with an error. The record does not process. Missing note/description or record notes are an invalid date range.
  • InvalidAssignedUserForAssignment
    • Process finished with an error. The record does not assign. The processed user is missing or incorrect.
  • InvalidAssignedUserGroupForAssignment
    • Process finished with an error. The record does not assign. The processed user group is missing or incorrect.
  • InvalidToState
    • Process finished with an error. Record transition does not occur. Destination state is missing or incorrect
  • InvalidFromState
    • Process finished with an error. Record transition does not occur. The initial state is missing or incorrect.
  • InvalidTransition
    • Process finished with an error. Record transition does not occur. Transition id or code is missing or incorrect.
  • InvalidAssignedUserForTransition
    • Process finished with an error. Record transition does not occur. User id or code is missing or incorrect.
  • GeneralError
    • Process finished with an error. The record does not process. System returned an unexpected exception. Must be analysis by next4biz BPM technical department.
  • EmptyDataFields
    • Process finished with an error. The record does not process. Workflow has no data fields (Workflow design issue).
  • InvalidCurrentUser
    • Process finished with an error. The record does not process. There is no such user in the system.
  • InvalidBusinessChannel
    • Process finished with an error. The record does not process. Service businesschannel parameter is missing or incorrect (Workflow design issue)
  • InvalidAssignee
    • Process finished with an error. The record does not assign. Assigned user id or code is incorrect.
  • InvalidCategory
    • Process finished with an error. The record does not occur. Service category parameter is missing or incorrect.
  • InvalidRecord
    • Process finished with an error. The record does not process. There no record is in the system. Record ID is incorrect.
  • NoResUser
    • Process finished with an error. The record does not process. Remote event user definition is missing or incorrect.
  • NoActiveResUser
    • Process finished with an error. The record does not process. Remote event user definition is not active.
  • ClientPasswordMismatch
    • Process finished with an error. The record does not process. Remote event user username or password is incorrect.
  • EmptyUsernameOrPassword
    • Process finished with an error. The record does not process. Remote event user username or password is empty.
  • NoAccess
    • Process finished with an error. The record does not process. A user has no auth for the specific operation. (Workflow design issue).
  • AuthorizedGroupsDoesNotContainUsergroup
    • Process finished with an error. The record does not assign. The relevant group is not among the authorized user groups. (Workflow design issue).
  • UserGroupDoesNotContainUser
    • Process finished with an error. The record does not assign. The relevant user is not in the user group which is required to be assigned. (Workflow design issue).
  • AuthorizationExpired
    • Process finished with an error. The record does not process. The user has no auth for the specific record. The record may be assigned to a different user or be in a state to the user has not authorized. Please check the record history page. (Workflow design issue).
  • MissingMandatoryFields
    • Process finished with an error. The record does not process. Please fill the all mandatory data fields in the error message. (Workflow design issue).
  • NoVisibleDataField
    • Process finished with an error. The record does not process. The user has no auth for specific record’s fields. Please check the user record authorization. (Workflow design issue).
  • PageHasNoDataField
    • Process finished with an error. The record does not process. The relevant page has no data field (Workflow design issue).
  • EmptyTransitionUserGroups
    • Process finished with an error. Record transition does not occur. The list of authorized user groups for transition is empty. (Workflow design issue).
  • SelectedUsergroupNotAuthorizedForTransition
    • Process finished with an error. Record transition does not occur. The relevant user group is not in the user groups to authorized for the transition.
  • UserNotMember
    • Process finished with an error. Record transition does not occur. The relevant user is not a member of the user groups to authorized for the transition.
  • CategoryWorkflowRelation
    • Process finished with an error. The record does not process. The relevant category is not related to the selected workflow. (Workflow design issue).
  • WorkflowHasNoRelatedCategory
    • Process finished with an error. The record does not process. The relevant category list is empty for the selected workflow. (Workflow design issue).
  • EmptyLifeCycle
    • Process finished with an error. The record does not process. The record lifecycle list is empty. Must be analysis by Opheleia technical department.
  • XML
ENDPOINT DEFINITION
POST
REQUEST BODY
                                    
                                        <Document>
   <Name>{Document Name}</Name>
   <TypeCode>{Document type unique code}</TypeCode>
   <Value>{base64 document value}</Value>
</Document>
RESPONSE BODY
                                    
                                        <AddDocumentResponse xmlns="http://tempuri.org/">
    <AddDocumentResult xmlns:a="..." >
        <a:ProcessMessage>IssueUpdated Success</a:ProcessMessage>
        <a:ProcessStatus>Success</a:ProcessStatus>
        <a:RecordID>5388</a:RecordID>
    </AddDocumentResult>
</AddDocumentResponse>