POST /ws/rest/service/v2/bp/record
Purpose:
Create a record in a specific BP in a shell based on "project_number" (provided in input JSON options) or from Company level if the project or shell number is not provided.
The input JSON provides various options to be considered for fetching the data.
This V2 service will use the step form (creation form) to create the BP record. All of the required fields and validation rules will be run against the creation form used in the workflow details.
Input:
All parameters should be URL encoded.
Both input & output in JSON format in the body.
Create BP Record Input JSON
{
"options":{
"project_number" : "P-0002",
"bpname":"Vendors",
"workflow_details":{
"workflow_name":"workflow_name",
"user_name":"first_name last_name",
"action_name":"action_name"
}
},
"data":[
{
"record_no":"hello",
"uuu_user_id":"a@abc.com",
"title":"v-00101",
"uveLicenseNoTB16":null,
"uuu_contact_company":"v-00101",
"uveCOIAmoutCA":0,
"_bp_lineitems":[
{
"uirCntctFstNmTB":"a",
"uuu_tab_id":"List of Contacts",
"title":"t",
"short_desc":"Vendor Contact",
"uriCntctLstNmTB":"b",
"ugenStatePD":null,
"ugenZipCodeTXT16":null,
"uveEmailTB120":"hello@abc.com",
"ugenAddress3TXT120":null
}
],
"creator_id":"Company Administrator",
"uveVendorIDTB16":"v-00101",
"uuu_contact_first_name":"a",
"status":"Active"
}
]
}
Notes:
- If "record_no" is not provided, then an auto-generated "record_no" will be assigned to the record. If a unique "record_no" is provided, then the record will be created with a record number.
- Field properties such as Read-only in step form (creation form) will be honored. The Field mandatory in step form must be present in Integration Form with direction set as "both" or "input"
- Field direction provided in Integration form will be honored.
- Auto-Creation setting is mandatory in Shell or Company BP Setup in the Admin mode.
- In input JSON options, the "project_number" specifies the shell in which the records exist, if the "project_number" is not provided, then the records are considered to be from Company Level.
- The "bpname" is mandatory and is part of options form parameter.
- If the "workflow_details" is not specified, then the the auto-creation settings, defined on the BP setup, will be used.
- If the "workflow_details" are specified, then the three params "user_name," "workflow_name," and "action_name" are mandatory.
- The validations will be performed:
- If the user is a valid active user in the project.
- The workflow name is valid and active.
- User is an assignee (user/group) on the creation step of the workflow.
- Action name is valid outgoing link from the creation step.
- The following error messages may display:
- Enter a valid or an active user. (Missing key or invalid user name)
- The workflow name is not valid. (Missing key or invalid/inactive workflow name)
- The user does not have an active workflow template. (User is not an assignee on the creation step)
- The workflow action name is not valid. (Missing key or invalid outgoing action name from creation step)
Output:
JSON object containing 'status', 'data', 'message'
Sample: Create BP Response
{
"data": [],
"message": [
{
"_record_status": "success",
"uuu_user_id": "a@abc.com",
"uuu_record_last_update_date": "04-12-2018",
"uveFaxTB16": null,
"uveCertificateNoTB64": null,
"uvePrimaryContactTB64": "a",
"title": "v-00101",
"uveLicenseNoTB16": null,
"uuu_contact_company": "v-00101",
"uveCOIAmoutCA": 0,
"_bp_lineitems": [
{
"uirCntctFstNmTB": "a",
"uuu_user_workphone": null,
"uuu_tab_id": "List of Contacts",
"title": "t",
"ugenAddress1TXT120": null,
"ugenAddress2TXT120": null,
"ugenCountryPD": null,
"ugenCityTXT50": null,
"short_desc": "Vendor Contact",
"uriCntctLstNmTB": "b",
"ugenStatePD": null,
"ugenZipCodeTXT16": null,
"uveEmailTB120": "hello@abc.com",
"ugenAddress3TXT120": null
}
],
"uvePolicyNoTB32": null,
"record_no": "hello",
"_attachment": [
{
"file_name": "new 1.txt"
}
],
"uveVendorTypePD": "Architect",
"ugenCityTXT50": null,
"uveCoiExpDOP": null,
"uuu_dm_publish_path": "v_path",
"uuu_contact_last_name": "b",
"ugenZipCodeTXT16": null,
"uveEmailTB120": "a@abc.com",
"ugenAddress3TXT120": null,
"uveReferenceIdTB16": null,
"uuu_creation_date": "04-12-2018",
"ugenRemarksTB4000": null,
"uvePhoneTB64": null,
"uveTaxIDTB16": null,
"uveMinorityBusCB": 0,
"uveInsuranceCoTB32": null,
"ugenExpirationDateDOP": null,
"uveWomanOwnedCB": 0,
"uveVendorNameTB50": "v-00101",
"ugenAddress1TXT120": null,
"uveDisadvantagedBusCB": 0,
"ugenDiscipline": null,
"creator_id": "Company Administrator",
"ugenAddress2TXT120": null,
"ugenCountryPD": null,
"uveVendorIDTB16": "v-00101",
"ugenStatePD": null,
"uuu_contact_first_name": "a",
"status": "Active"
}
],
"status": 200
}
in case of any error:
{
"data": [],
"message": [
{
"_record_status": "Error Business Process record_no hello already exists. ",
"record": {
"uuu_user_id": "a@abc.com",
"uuu_record_last_update_date": "04-12-2018",
"uveFaxTB16": null,
"uveCertificateNoTB64": null,
"uvePrimaryContactTB64": "a",
"title": "v-00101",
"uveLicenseNoTB16": null,
"uuu_contact_company": "v-00101",
"uveCOIAmoutCA": 0,
"_bp_lineitems": [
{
"uirCntctFstNmTB": "a",
"uuu_user_workphone": null,
"uuu_tab_id": "List of Contacts",
"title": "t",
"ugenAddress1TXT120": null,
"ugenAddress2TXT120": null,
"ugenCountryPD": null,
"ugenCityTXT50": null,
"short_desc": "Vendor Contact",
"uriCntctLstNmTB": "b",
"ugenStatePD": null,
"ugenZipCodeTXT16": null,
"uveEmailTB120": "hello@abc.com",
"ugenAddress3TXT120": null
}
],
"uvePolicyNoTB32": null,
"record_no": "hello",
"_attachment": [
{
"file_name": "new 1.txt"
}
],
"uveVendorTypePD": "Architect",
"ugenCityTXT50": null,
"uveCoiExpDOP": null,
"uuu_dm_publish_path": "v_path",
"uuu_contact_last_name": "b",
"ugenZipCodeTXT16": null,
"uveEmailTB120": "a@abc.com",
"ugenAddress3TXT120": null,
"uveReferenceIdTB16": null,
"uuu_creation_date": "04-12-2018",
"ugenRemarksTB4000": null,
"uvePhoneTB64": null,
"uveTaxIDTB16": null,
"uveMinorityBusCB": 0,
"uveInsuranceCoTB32": null,
"ugenExpirationDateDOP": null,
"uveWomanOwnedCB": 0,
"uveVendorNameTB50": "v-00101",
"ugenAddress1TXT120": null,
"uveDisadvantagedBusCB": 0,
"ugenDiscipline": null,
"creator_id": "Company Administrator",
"ugenAddress2TXT120": null,
"ugenCountryPD": null,
"uveVendorIDTB16": "v-00101",
"ugenStatePD": null,
"uuu_contact_first_name": "a",
"status": "Active"
}
}
],
"status": 3000
}
Status codes are:
1>200, for success.
2>3000, for Partial success.