API mub | Workflow - Get details workflow BP
This article is itended to document the API mub | GetDetails BP Route: GET => http://api.mub.cloud/api/v2/workflow/ {workflow_generals_id} API Field Field Type Description, example. workflos_steps_id Number Example: 3…
Moises ScarpinPublicado 08 de fev. de 20247 min de leitura
This article is itended to document the API mub | GetDetails BP
Route: GET => http://api.mub.cloud/api/v2/workflow/{workflow_generals_id}
|
API Field |
Field Type |
Description, example. |
|
workflos_steps_id |
Number |
Example: 333 |
See below full object of request and expected response.
Request example:
http://api.mub.cloud/api/v2/workflow/333
Response example:
{
"success": true,
"message": "Workflows Details successfully listed!",
"data": {
"id": 333,
"process_generals_id": 1,
"status": "PENDING",
"start_date_time": "2021-10-29 11:12:06",
"sla_date_time": "2021-11-03 09:13:00",
"end_date_time": null,
"user": "Integration User",
"object_id": null,
"steps": [
{
"id": 475,
"step_type": "TRIGGERING_EVENT",
"position": "0.000",
"step_connector": false,
"status": "FINISHED",
"business_area": null,
"user_group": null
},
{
"id": 476,
"step_type": "CONNECTOR",
"position": "1.000",
"step_connector": true,
"status": "NOTSTARTED",
"business_area": null,
"user_group": null
},
{
"id": 477,
"step_type": "CONNECTOR",
"position": "1.000",
"step_connector": true,
"status": "FINISHED",
"business_area": null,
"user_group": null
},
{
"id": 478,
"step_type": "BUSINESS_AREA",
"position": "2.000",
"step_connector": false,
"status": "PENDING",
"business_area": "CCAD",
"user_group": "CCAD"
},
{
"id": 479,
"step_type": "CONNECTOR",
"position": "3.000",
"step_connector": true,
"status": "NOTSTARTED",
"business_area": null,
"user_group": null
},
{
"id": 480,
"step_type": "BUSINESS_AREA",
"position": "4.000",
"step_connector": false,
"status": "NOTSTARTED",
"business_area": "CCAD",
"user_group": "CCAD"
}
],
"body": {
"process_generals_id": null,
"languages_generals_id": null,
"code": "APPLE_INC",
"countries_continents_regions_generals_id": "us",
"type": "ORGANIZATION",
"partner_functions_ids": [
"CUSTOMER",
"VENDOR",
"TRANSPORTER"
],
"general_data": {
"company_name": "Apple Inc. 2",
"person_last_name": null,
"person_birth_date": "1971-12-10",
"person_first_name": null,
"company_trade_name": "Apple 2",
"bp_aux_person_titles_id": null,
"company_foundation_date": "1978-01-31"
},
"status": "A",
"bp_documents": [
{
"issuer": "IRS",
"status": "A",
"category": "DOCUMENTATION",
"valid_to": "2030-01-01",
"valid_from": "2020-01-01",
"consulted_at": "2021-10-14",
"identification": "942404110",
"bp_aux_document_types_id": "CNPJ",
"bp_aux_document_types_description": "CNPJ",
"comments": [
{
"comment": "Main document",
"languages": [
{
"comment": "Documento principal",
"languages_generals_id": "pt-br"
},
{
"comment": "Main document",
"languages_generals_id": "en-US"
}
]
}
]
}
],
"bp_addresses": [
{
"city": "Cupertino",
"number": "1",
"region": "California",
"status": "A",
"district": "One Apple Park Way District",
"valid_to": "2030-01-01",
"complement": "All Build",
"valid_from": "2020-01-01",
"postal_code": "95014",
"address_line_1": "One Apple Park Way",
"address_line_2": "Apple Building",
"countries_description": "United States of America",
"bp_aux_addresses_types_id": "MAIN",
"bp_aux_addresses_types_description": "Main",
"countries_continents_regions_generals_id": "us",
"comments": [
{
"comment": "Main address",
"languages": [
{
"comment": "Endereço principal",
"languages_generals_id": "pt-br"
},
{
"comment": "Main address",
"languages_generals_id": "en-US"
}
]
}
]
}
],
"bp_contacts": [
{
"contact_last_name": "Sirangelo",
"bp_contacts_emails": [
{
"email": "eduardo.sirangelo@gmail.com",
"is_main": true,
"comments": [
{
"comment": "E-mail comment",
"languages": [
{
"comment": "E-mail comment",
"languages_generals_id": "en-US"
}
]
},
{
"comment": "Important comment",
"languages": [
{
"comment": "Important comment",
"languages_generals_id": "en-US"
}
]
}
]
},
{
"email": "joao@gmail.com",
"is_main": false,
"comments": [
{
"comment": "E-mail comment",
"languages": [
{
"comment": "E-mail comment",
"languages_generals_id": "en-US"
}
]
}
]
}
],
"contact_first_name": "Eduardo",
"bp_contacts_telephones": [
{
"is_main": true,
"telephone": "+55 54 98133-5826",
"comments": [
{
"comment": "Telephone comment",
"languages": [
{
"comment": "Telephone comment",
"languages_generals_id": "en-US"
}
]
},
{
"comment": "Important comment",
"languages": [
{
"comment": "Important comment",
"languages_generals_id": "en-US"
}
]
}
]
}
],
"bp_aux_person_titles_id": "MAIN",
"bp_aux_contacts_types_id": "PRIMARY",
"contact_manages_register": true,
"bp_aux_person_titles_description": "Sr.",
"bp_aux_contacts_types_description": "Main contact",
"comments": [
{
"comment": "Contact comment",
"languages": [
{
"comment": "Contact comment",
"languages_generals_id": "en-US"
}
]
}
]
}
],
"bp_shareholders": [
{
"full_name": null,
"shares_percentage": 5,
"shareholder_bp_generals_id": "CODE01"
},
{
"full_name": "Steve Jobs",
"shares_percentage": 55,
"shareholder_bp_generals_id": null
},
{
"full_name": "Tim Cock",
"shares_percentage": 45,
"shareholder_bp_generals_id": null
}
],
"bp_executives": [
{
"full_name": "Steve Jobs",
"observations": "Member of Concil",
"executive_bp_generals_id": null,
"bp_aux_executive_positions_id": null
},
{
"full_name": null,
"observations": null,
"executive_bp_generals_id": "CODE01",
"bp_aux_executive_positions_id": "ADVIDOR"
}
],
"bp_social_medias": [
{
"url": "https://facebook.com/apple",
"bp_aux_social_medias_types_id": "FACEBOOK",
"bp_aux_social_medias_types_description": "Facebook"
},
{
"url": "https://instagram.com/apple",
"bp_aux_social_medias_types_id": "INSTAGRAM",
"bp_aux_social_medias_types_description": "Instagram"
},
{
"url": "https://www.youtube.com/apple",
"bp_aux_social_medias_types_id": "YOUTUBE",
"bp_aux_social_medias_types_description": "YouTube"
}
],
"bp_relations": [
{
"valid_to": "2030-01-22",
"direction": "IS",
"valid_from": "2020-01-16",
"related_bp_generals_id": "CODE01",
"bp_aux_relations_types_id": "COMMERCIAL_PARTNER",
"bp_aux_relations_types_description": "Commercial partner"
},
{
"valid_to": "2030-01-22",
"direction": "HAS",
"valid_from": "2020-01-16",
"related_bp_generals_id": "CODE01",
"bp_aux_relations_types_id": "SALES_REPRESENTATIVE",
"bp_aux_relations_types_description": "Sales representative"
}
],
"bp_aux_br_tipo_tributacoes_id": "LUCRO_PRESSUMIDO",
"bp_aux_br_natureza_juridicas_id": "204-6",
"bp_taxes": {
"br_cnae_principal_code": "5222-2/00",
"br_cnae_secundario_codes": [
"6822-6/00",
"7312-2/00",
"5223-1/00"
]
},
"bp_bank_accounts": [
{
"pix": "942404110",
"city": "São Paulo",
"status": "A",
"address": "Av. Paulista",
"aba_code": "ABA-879",
"iban_code": "IBAN-564",
"branch_code": "1445",
"account_type": "CURRENT",
"branch_digit": "8",
"account_digit": "7",
"account_number": "111544",
"countries_description": "República Federativa do Brasil",
"bp_aux_br_bank_codes_id": 1,
"bp_aux_bank_codes_description": "001 - BANCO DO BRASIL S.A.",
"bp_aux_br_bank_codes_description": "001 - BANCO DO BRASIL S.A.",
"bp_aux_bank_accounts_categories_id": "MAIN",
"countries_continents_regions_generals_id": "br",
"bp_aux_bank_accounts_categories_description": "Main",
"comments": [
{
"comment": "Brazilian bank account",
"languages": [
{
"comment": "Conta no Brasil",
"languages_generals_id": "pt-br"
},
{
"comment": "Brazilian bank account",
"languages_generals_id": "en-US"
}
]
}
]
},
{
"pix": null,
"city": "Cupertino",
"status": "A",
"address": "3ª Street, 74",
"aba_code": "ABA-546",
"iban_code": "IBAN-213",
"branch_code": "7411",
"account_type": null,
"branch_digit": null,
"account_digit": null,
"account_number": "111544",
"br_account_type": null,
"br_branch_digit": null,
"br_account_digit": null,
"bp_aux_bank_codes_id": null,
"countries_description": "United States of America",
"bp_aux_bank_accounts_categories_id": "MAIN",
"countries_continents_regions_generals_id": "us",
"bp_aux_bank_accounts_categories_description": "Main",
"comments": [
{
"comment": "USA Bank Account",
"languages": [
{
"comment": "USA Bank Account",
"languages_generals_id": "en-US"
}
]
}
]
}
],
"bp_market_categories": [
{
"category": "TIPI",
"code": "03046210"
}
],
"bp_market_annual_gross_billing": [
{
"annual_gross_billing_year": 2020,
"annual_gross_billing_month": "12",
"annual_gross_billing_value": 12345678.32,
"annual_gross_billing_currencies_generals_id": "USD",
"annual_gross_billing_currencies_generals_description": "American Dollar"
}
],
"bp_market_operation_locations": [
{
"description": "USA"
},
{
"description": "BRAZIL"
},
{
"description": "EUROPE"
}
],
"bp_market_delivery_locations": [
{
"description": "USA"
},
{
"description": "BRAZIL"
},
{
"description": "EUROPE"
}
],
"bp_market_main_vendors": [
{
"description": "INTEL"
},
{
"description": "AMD"
},
{
"description": "APPLE Industries"
}
],
"bp_market_main_competitors": [
{
"description": "Microsoft"
}
],
"bp_market_size": "EGP",
"bp_market_employees_quantity": "MORE_10K",
"bp_market_main_customers": [
{
"name": "USA",
"percentage": 88.54
},
{
"name": "Brazil",
"percentage": 9
},
{
"name": "Europe",
"percentage": 3
}
],
"bp_marketing_website": "https://www.empresa.com",
"bp_marketing_description": {
"description": "Um texto longo em br",
"languages": [
{
"description": "Um texto longo em br",
"languages_generals_id": "pt-br"
},
{
"description": "Long text in Brazilian Portuguese",
"languages_generals_id": "en-US"
}
]
},
"user_external_agents": [
{
"email": "gilmar.do.bogas.dourado@gmail.com"
}
],
"bp_additional_fields": [
{
"36bc9946-df2a-fc29-2097-682fc29257dd": {
"description": "ID-123456"
}
},
{
"56e83b9f-0650-5458-af82-e704c0cf0f40": "Um texto longo em br"
}
],
"workflow_additional_fields": [],
"tags": [
"company",
"BP",
"Software company"
]
}
}
}