NAV

Authentication

An authentication call enables you to gain access to your Network instance.

You provide a Network user name and password, and receive a session ID in response. You must pass this session ID as the value for the authorization HTTP header for all subsequent API requests.

Authenticate

Sample request

curl -X POST -H "Content-Type: application/x-www-form-urlencoded" -d 'username=john.smith@my.veevanetwork.com&password=12345' "https://my.veevanetwork.com/api/v21.0/auth"

Sample response

{
   "networkIds" : [
      {
         "name" : "VEEVANETWORK",
         "url" : "https://my.veevanetwork.com/api",
         "id" : 500
      }
   ],
   "networkId" : "500",
   "userId" : 552,
   "responseStatus" : "SUCCESS",
   "sessionId" : "2DC1C11F33010EBE49042B9CA1E9C74B6ED9E7C169D08C4B395B2C5459CD1C133BBFE77DBDEE8A7BEEC6C3D011E180303A2D86121A122D978174229F9F5B3350E0BE80F2C5EB53F75A930A636DBAE530"
}

This API enables user authentication.

Endpoint URL

https://{DNS}/api/{version}/auth

Parameters
username The user ID for Network; for example,
john.smith@veevanetwork.com.
password The password for the user ID.
Response
responseStatus The status of the response in Network.
sessionId The session ID for subsequent API calls. This should be set with an authorization header.
userId An ID number for the authenticated user.
networkIds Details about each Network instance the authenticated user can access:
  • id - An ID number for the authenticated user.
  • name - The name of the Network instance.
  • url - The Network URL used for subsequent API calls.
networkId The Network ID number for the network that the authenticated user most recently accessed.

Associating custom keys

This API enables you to associate or disassociate custom keys with entities and child entities.

Associate custom key to entity

Sample request

curl -X POST -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/entities/Network:Entity:932241745093790303/custom_keys?custom_key_source_type=HCO&custom_key_item_type=DCRID__v&custom_key_value=12345'

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new HCPs or HCOs are downloaded from Network without going through the full change request process.

The external identifier is associated to the entity (vid_key) specified in the URL.

Note: This API requires system administrator or API-only permissions.

Endpoint URL

https://{DNS}/api/{version}/entities/{vid_key}/custom_keys

Parameters
custom_key_source_type The source of the new key.
custom_key_item_type The item type for the new key.
custom_key_value The value for the new key.
system_name The name of the system for the new key.
Response
responseStatus The status of the request from Network.

Notes

responseStatus returns a failure if any standard errors occur or:

Changelog

Batch associate custom keys to entities

Sample request

curl -i -H "Authorization: 57696C6C205261...6368204C6F7368" -H "Content-type: application/json" -X POST -d "@ckeys_postdata.json" 'https://my.veevanetwork.com/api/v21.0/entities/custom_keys/associate/batch'

Sample POST data

{
  "entities": [
    {
      "vid_key": "Network:Entity:291256782200767488",
      "custom_key_source_type": "VCRM",
      "custom_key_item_type": "ENTITY",
      "custom_key_value": "123123123123",
      "system_name": "VCRM"
    },
    {
      "vid_key": "Network:Entity:291256782200767400",
      "custom_key_source_type": "VCRM",
      "custom_key_item_type": "ENTITY",
      "custom_key_value": "123456789",
      "system_name": "VCRM"
    },
    {
      "vid_key": "Network:Entity:291256796914385922",
      "custom_key_source_type": "VCRM",
      "custom_key_item_type": "ENTITY",
      "custom_key_value": "987654321",
      "system_name": "VCRM"
    }
  ]
}

Sample response: Success

{
   "responseStatus": "SUCCESS"
}

Sample response: Partial success

{
  "responseStatus": "PARTIAL_SUCCESS",
  "errors": [
    {
      "type": "INVALID_DATA",
      "message": "No entity found with the given Id 291256782200767400"
    }
  ]
}

This API enables you to submit external key identifiers whenever new HCPs or HCOs are downloaded from Network without going through the full change request process.

The external identifiers are associated to the entities (vid_key) specified in the request.

Note: This API requires system administrator or API-only permissions.

Endpoint URL

https://{DNS}/api/{version}/entities/custom_keys/associate/batch

This API takes no parameters.

POST data
entities An array of objects:
  • vid_key - The external HCP or HCO vid_key.
  • custom_key_source_type - The source of the new key.
  • custom_key_item_type - The item type for the new key.
  • custom_key_value - The value for the new key.
  • system_name - The name of the system for the new key.
Response
responseStatus The status of the response from Network.
errors An array of error messages:
  • type - the error type.
  • message - a detailed message for the error type. This message is subject to change and is not contractual for error handling.

Notes

responseStatus returns a failure if any standard errors occur or a status of PARTIAL_SUCCESS if:

Associate custom key to children

Sample request

curl -X GET -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/entities/myveevanetwork:HCO:1325540/children/Network:ParentHCO:6044433/custom_keys?custom_key_source_type=VCRM&custom_key_item_type=ChildAccount&custom_key_value=789102&system_name=VCRM2'

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new children (address, license, or parent HCOs) are downloaded from Network without going through the full change request process.

The external identifier is associated to the children (children_key) specified in the URL.

Note: This API requires system administrator or API-only permissions.

Endpoint URL

https://{DNS}/api/{version}/entities/{vid_key}/children/{children_key}/custom_keys

Parameters
custom_key_source_type The source of the new key.
custom_key_item_type The item type for the new key.
custom_key_value The value for the new key.
system_name The name of the system for the new key.
Response
responseStatus The status of the response from Network.

Notes

responseStatus returns a failure if any standard errors occur or:

Changelog

Batch associate custom key to children

Sample request

curl -i -H "Authorization: 57696C6C205261...6368204C6F7368" -H "Content-type: application/json" -X POST -d "@childkeys_postdata.json" 'https://my.veevanetwork.com/api/v21.0/entities/children/custom_keys/associate/batch'

Sample POST data

{
  "entities": [
    {
      "vid_key": "Network:Entity:291256782200767488",
      "child_type": "licenses",
      "child_key": "Network:License:291256858360939523",
      "custom_key_source_type": "VCRM",
      "custom_key_item_type": "LICENSE",
      "custom_key_value": "123456789",
      "system_name": "VCRM"
    },
    {
      "vid_key": "Network:Entity:291256748453397507",
      "child_type": "addresses",
      "child_key": "Network:Address:291256848747594752",
      "custom_key_source_type": "VCRM",
      "custom_key_item_type": "ADDRESS",
      "custom_key_value": "123123123123",
      "system_name": "VCRM"
    },
    {
      "vid_key": "Network:Entity:291256757999633408",
      "child_type": "parent_hcos",
      "child_key": "Network:ParentHCO:291256757999633600",
      "custom_key_source_type": "VCRM",
      "custom_key_item_type": "CHILDACCOUNT",
      "custom_key_value": "987654321",
      "system_name": "VCRM"
    }
  ]
}

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new children (address, license, or parent HCOs) are downloaded from Network without going through the full change request process.

The external identifiers are associated to the children (children_key) specified in the request.

Note: This API requires system administrator or API-only permissions.

Endpoint URL

https://{DNS}/api/{version}/entities/children/custom_keys/associate/batch

This API takes no parameters.

POST data
entities An array of objects:
  • vid_key - The external HCP or HCO vid_key.
  • child_type - The child type (address, license, or parentHCO). To select a child by vid_key alone, specify the general type (children).
  • child_key - The vid_key of the child object.
  • custom_key_source_type - The source of the new key.
  • custom_key_item_type - The item type for the new key.
  • custom_key_value - The value for the new key.
  • system_name - The name of the system for the new key.
Response
responseStatus The status of the response from Network.
errors An array of error messages:
  • type - the error type.
  • message - a detailed message for the error type. This message is subject to change and is not contractual for error handling.

Notes

responseStatus returns a failure if any standard errors occur or a status of PARTIAL_SUCCESS if:

Disassociate custom key

Sample request

curl DELETE -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/custom_keys/MASTER__v:HCP:936779911995786851

> Sample response

```json 
{
   "responseStatus": "SUCCESS"
}

This API enables you to deactivate external key identifiers for any entity (an HCP, HCO, address, license, or parent HCO) in Network without going through the full change request process.

The external identifier (vid_key) specified in the URL is disassociated from the entity.

Note: This API requires system administrator or API-only permissions.

Endpoint URL

https://{DNS}/api/{version}/custom_keys/{vid_key}

This API takes no parameters.

Response
responseStatus The status of the response from Network.

Notes

responseStatus returns a failure if any standard errors occur or:

Inactivated keys will not match again; a new associate API call for an inactivated key will create a new key.

Batch disassociate custom key

Sample request

curl -i -H "Authorization: 57696C6C205261...6368204C6F7368" -H "Content-type: application/json" -X POST -d "@ckeys_postdata.json" 'https://my.veevanetwork.com/api/v21.0/custom_keys/disassociate/batch'

Sample POST data

{
  "entities": [
    {
      "vid_key": "VCRM:ENTITY:291256782200767500"
    },
    {
      "vid_key": "VCRM:LICENSE:123456789"
    },
    {
      "vid_key": "VCRM:ADDRESS:123123123123"
    }
  ]
}

Sample response: Success

{
   "responseStatus": "SUCCESS"
}

This API enables you to inactivate external key identifiers for any entity (HCP, HCO, address, license, or parent HCO) in Network without going through the full change request process.

The external identifier is disassociated from the entities (vid_key) specified in the request.

Note: This API requires system administrator or API-only permissions.

Endpoint URL

https://{DNS}/api/{version}/custom_keys/disassociate/batch

This API takes no parameters.

POST data
entities An array of objects:
  • vid_key - The external HCP, HCO, address, license, or parent HCO vid_key supplied by the client.
Response
responseStatus The status of the response from Network.
errors An array of error messages:
  • type - the error type.
  • message - a detailed message for the error type. This message is subject to change and is not contractual for error handling.

Notes

responseStatus returns a failure if any standard errors occur or a status of PARTIAL_SUCCESS if:

Inactivated keys will not match again; a new associate API call for an inactivated key will create a new key.

Batch API calls are limited to 500 operations per call. Attempts to submit more operations result in a failure of all operations.

Manage change requests

Change requests are the standard method used to submit changes in Network. The Change request APIs enable you to create change requests to add, update, merge, or split HCPs and HCOs.

Address, License, and ParentHCO information, including their custom keys, are part of each HCP and HCO. To add a new Address, License, or ParentHCO (including new custom keys) to either an HCP or HCO, you use the Create change request API. You can provide the vid_key of the HCP or HCO and the external ID of the new Address, License, or ParentHCO for more efficient processing.

Change request APIs to delete entities are not available, as information in Network cannot be deleted. For HCPs and HCOs, a change request for the Status field is the standard method to deactivate resources. Addresses, Licenses, and ParentHCOs follow the same procedure as part of the HCP or HCO in the Network data model.

The fields of any entity call are the properties for the corresponding entity. You can get the list of properties by accessing the Network external data model to see all fields for a particular entity. The data model also describes the fields required to create any resources, as well as any group of fields that must be submitted all together, if any of them changes (for example, address fields for regular mail).

If successful, each change request record received is responded to with a unique Network change request ID and date/time value upon reception.

Create a change request

Sample request

curl -i -H "Authorization: 57696C6C205261...6368204C6F7368" -H "Content-type: application/json" -X POST -d "@dcrs_postdata.json" 'https://my.veevanetwork.com/api/v21.0/change_request'

Sample POST data:
Create HCP with two addresses, one license, and one parentHCO

{  
  "reserve_vid": true,
  "metadata": {
    "creator": "crmuser@pharma.com",
    "system": "VCRM",
    "note": "John Smith is a new doctor in the Network Hospital",
    "source": "Veeva CRM"
  },
  "entity_type": "HCP",
  "vid_key": "VCRM:HCP:001A000000pKagwIAC",
  "entity": {
    "attribute 1": "Value 1",
    "attribute 2": "Value 2",
    " ... ": " ... ",
    "addresses__v": [
      {
        "vid_key": "VCRM:Address:001A000000pLjigIAC",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      }
    ],
    "licenses__v": [
      {
        "vid_key": "VCRM:License:001A000000pNfruIAC",
        "address_vid_key": "VCRM:Address:001A000000pLjigIAC",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      }
    ],
    "parent_hcos__v": [
      {
        "vid_key": "VCRM:ChildAccount:001A000000pLkioIAC",
        "parent_hco_vid_key": "Network:HCO:215249678634058752",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      }
    ]
  }
}

Sample POST data:
Update HCP with an existing address, a new address, and existing license

{
  "metadata": {
    "creator": "crmuser@pharma.com",
    "system": "VCRM",
    "note": "John Smith is a new doctor in the Network Hospital",
    "source": "Veeva CRM"
  },
  "entity_type": "HCP",
  "vid_key": "Network:HCP:214065474881717253",
  "entity": {
    "addresses__v": [
      {
        "vid_key": "Network:Address:214066274852930560",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      },
      {
        "vid_key": "CRM:Address:001A000000hTapwIAC",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      }
    ],
    "licenses__v": [
      {
        "vid_key": "VCRM:License:001A000000pNfruIAC",
        "address_vid_key": "VCRM:Address:001A000000hTapwIAC",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      }
    ]
  }
}

Sample POST data:
Create HCO with one address and one parentHCO

{
  "metadata": {
    "creator": "crmuser@pharma.com",
    "system": "VCRM",
    "note": "New Hospital",
    "source": "Veeva CRM"
  },
  "entity_type": "HCO",
  "vid_key": "VCRM:HCO:001A000000pClakIAC",
  "entity": {
    "attribute 1": "Value 1",
    "attribute 2": "Value 2",
    " ... ": " ... ",
    "addresses__v": [
      {
        "vid_key": "VCRM:Address:001A000000pPlkjIAC",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      }
    ],
    "parent_hcos__v": [
      {
        "vid_key": "VCRM:ChildAccount:001A000000pLkioIAC",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      }
    ]
  }
}

Sample POST data: Update HCO with new license

{
  "metadata": {
    "creator": "crmuser@pharma.com",
    "system": "VCRM",
    "note": "Update Hospital License",
    "source": "Veeva CRM"
  },
  "entity_type": "HCO",
  "vid_key": "Network:HCO:214065474881717253",
  "entity": {
    "licenses__v": [
      {
        "vid_key": "VCRM:License:001A000000pNfruIAC",
        "address_vid_key": "Network:Address:210909264435217422",
        "attribute 1": "Value 1",
        "attribute 2": "Value 2",
        " ... ": " ... "
      }
    ]
  }
}

Sample POST data: Create HCP with create unverified on

{
  "create_unverified": true,
    "metadata": {
    "creator": "crmuser@pharma.com",
    "system": "VCRM",
    "note": "John Smith is a new doctor in the Network Hospital",
    "source": "Veeva CRM"
  },
  "entity_type": "HCP",
  "entity": {  }
}

Sample response: Success

{
   "responseStatus": "SUCCESS",
   "change_request_id": 63259874100112589  
}

Sample response: Failure

{
    "responseStatus": "FAILURE",
    "responseMessage": "Change requests are not supported for: EMPLOYEE__C.",
    "errors": [
        {
            "type": "UNSUPPORTED_TYPE",
            "message": "Change requests are not supported for: EMPLOYEE__C."
        }
    ],
    "errorType": "UNSUPPORTED_TYPE"
}

This API enables you to create a Network change request to add or update an HCP or HCO and related entities (including addresses, licenses, or parentHCOs) for gray data only.

Change requests created using the API against orange data will be rejected.

Endpoint URL

https://{DNS}/api/{version}/change_request

This API takes no parameters.

POST data
reserve_vid Boolean type. Request to reserve a VID immediately when an add request is submitted.
metadata Details about the request being made. The details are saved in the entity history if the change is accepted (an array of fields within itself):
  • creator - the name of the user that generated the change request
  • note - details about the change request
  • source - additional information about the source of the change request
  • system - the name of the system that generated the change request (used for reference aliases and other validation)
entity_type The entity type of the change request (HCP or HCO).
vid_key The external HCP or HCO vid_key supplied by the client.
create_unverified Override the workflow settings for creating unverified records. If True, an unverified record is created with the DCR. If False, only the DCR is created. If not specified, the workflow settings persist.
entityDetails of the changes, one per field, for the entity provided:
  • field - The Network API name of the HCP or HCO field.
  • value - The new value of the HCP or HCO field.
  • addresses__v - An array of change requests for addresses, one per address, for the entity provided:
    • vid_key - the address vid_key supplied by the client
    • field - the Network API name of the HCP or HCO Address field
    • value - the new value of the HCP or HCO Address field
  • licenses__v - An array of change requests for licenses, one per license, for the entity provided:
    • vid_key - the license vid_key supplied by the client
    • address_vid_key - the address vid_key to which the license is related, supplied by the client
    • address_index - the address index within the addresses__v object. Can be used when vid_key is not available. (The index is zero-based.)
    • field - the Network API name of the HCP or HCO License field
    • value - the new value of the HCP or HCO License field
  • parent_hcos__v - An array of change requests for parent HCOs, one per parent HCO, for the entity provided:
    • vid_key - the parent HCO vid_key supplied by the client
    • parent_hco_vid_key - the actual HCO vid_key of the parent, supplied by the client
    • field - the Network API name of the HCP or HCO ParentHCO field
    • value - the new value of the HCP or HCO ParentHCO field
  • custom_keys__v - An array of change requests for custom keys, one per custom key, for the entity provided:
    • vid_key - the custom key vid_key supplied by the client
    • field - the Network API name of the custom key field
    • value - the new value of the custom key field
Response
responseStatus The status of the response from Network.
change_request_id The ID of the change request generated in Network.

Notes

Cancel change request

Sample request

curl DELETE -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/change_request/929455217942072479'

Sample response

{
   "responseStatus": "SUCCESS",
   "change_request_id": 929455217942072479 
}

Endpoint URL

https://{DNS}/api/{version}/change_request/{change_request_id}

This API takes no parameters.

Response
responseStatus The status of the response in Network.
change_request_id The ID of the change request cancelled in Network.

Notes

Retrieve change request

Sample request

curl -X GET -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/change_requests/929455217942072479'

Sample response

{
   "change_requests" : [
      {
         "created_date" : "2016-12-08T13:59:22.000-08:00",
         "original_task_type" : "ADD_REQUEST",
         "entity" : {
            "kaiser__v" : {
               "change_requested" : "N",
               "result" : null,
               "final_value" : null
            },
            "pdrp_optout__v" : {
               "final_value" : null,
               "result" : null,
               "change_requested" : "N"
            },
            "fellow__v" : {
               "final_value" : null,
               "change_requested" : "N",
               "result" : null
            },
            "first_name__v" : {
               "result" : "CHANGE_ACCEPTED",
               "change_requested" : "Tim",
               "final_value" : "Tim"
            },
            "last_name__v" : {
               "change_requested" : "Othy",
               "result" : null,
               "final_value" : null
            },
            "primary_country__v" : {
               "final_value" : null,
               "result" : null,
               "change_requested" : "US"
            },
            "hcp_status__v" : {
               "change_requested" : "A",
               "result" : null,
               "final_value" : null
            },
            "grad_training__v" : {
               "change_requested" : "N",
               "result" : null,
               "final_value" : null
            },
            "custype__c" : {
               "final_value" : null,
               "result" : null,
               "change_requested" : "4:37"
            },
            "ama_do_not_contact__v" : {
               "final_value" : null,
               "change_requested" : "N",
               "result" : null
            },
            "hcp_type__v" : {
               "final_value" : null,
               "change_requested" : "P",
               "result" : null
            },
            "testtesttest__c" : {
               "change_requested" : "False",
               "result" : null,
               "final_value" : null
            }
         },
         "status__v" : "CHANGE_PARTIALLYPROCESSED",
         "vid__v" : "929455217958715423",
         "reserved_vid" : null,
         "change_request_id" : "929455217942072479",
         "entity_type" : "HCP",
         "metadata" : {
            "system" : null,
            "source" : "Entity Profile Editor",
            "creator" : "john.smith@my.veevanetwork.com",
            "note" : "New record added via Network portal."
         },
         "result__v" : null,
         "parent_task_ids" : [],
         "taskCountry" : "US",
         "vid_key" : null,
         "task_type" : "ADD_REQUEST",
         "resolution_notes" : [
            {
               "comment" : "fas",
               "created_date" : "2016-12-19T07:46:39.766-08:00",
               "code" : null,
               "fields" : [
                  "kaiser__v",
                  "hcp_type__v",
                  "last_name__v",
                  "hcp_status__v",
                  "pdrp_optout__v",
                  "primary_country__v",
                  "fellow__v",
                  "grad_training__v",
                  "ama_do_not_contact__v",
                  "first_name__v"
               ]
            }
         ],
         "completed_date" : null
      }
   ],
   "responseStatus" : "SUCCESS"
}

Sample request: Retrieve processed and cancelled change requests

curl -X GET -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/change_requests/544408527049851904,544411763097994240?status=CHANGE_PROCESSED&status=CHANGE_CANCELLED'

This API enables you to retrieve response information for the create, update, and merge change requests submitted by a client application.

Endpoint URL

https://{DNS}/api/{version}/change_requests/{change_request_ids}

Optional parameters
status Retrieve change requests of a specific status from the IDs provided.
systemName Return target aliases specified for this system as well as the external customer keys associated to it. If a system is not provided, Network will return default reference value codes and empty external custom keys.
includeEntity Return the full entity or entities related to the requested change requests. An entity for a change request is determined from the entity identifier (vid__v) of the change request.
sinceDate Include change requests modified after the specified date (exclusive). This value is specified in epoch time in milliseconds.
toDate Include change requests modified on or before the specified date (inclusive). This value is specified in epoch time in milliseconds.
Response
responseStatus The status of the response in Network.
change_requests An array of change requests. See the Change request response attributes table for details.
entities An array of entities associated with the change requests. Each entity is related to a change request through the vid__v field.
Change request response attributes
metadata Details about the request. These details are stored in the entity history if the change is accepted.
  • creator - The name of the user that generated the request.
  • note - Details about the request.
  • source - Additional information about the source of the request.
  • system - The name of the system that generated the request. This is used for reference aliases and other validation.
entity Details of the response changes, one per field, for the entity provided.
  • field - The Network API name of the HCP or HCO field.
    • change_requested - The value of the requested change.
    • final_value - The new value of the field.
    • result - See the Field Results table.
  • master_keys - An array of external keys to identify the entity used when updating change requests using the APIs.
  • external_custom_keys - An array of active external keys to identify the entity loaded by subscription.
  • addresses__v - An array of address response changes, one per address, for the entity provided. See the Child Object Attributes table for more information.
  • licenses__v - An array of license response changes, one per license, for the entity provided. See the Child Object Attributes table for more information.
  • parent_hcos__v - An array of parent HCO response changes, one per parent HCO, for the entity provided. See the Child Object Attributes table for more information.
  • custom_keys__v - An array of custom key response changes, one per custom key, for the entity provided. See the Child Object Attributes table for more information.
task_type The original change request type:
  • ADD_REQUEST - An add request for a new record in Network.
  • CHANGE_REQUEST - A change request submitted on an existing record in Network.
original_task_type The final change request type as an add request could become a change request:
  • ADD_REQUEST - An add request for a new record in Network.
  • CHANGE_REQUEST - A change request submitted on an existing record in Network.
taskCountry The country code of the entity.
change_request_id The change request ID.
status__v The change request status:
  • CHANGE_NEW - A new task has been received but not run yet.
  • CHANGE_PENDINGREVIEW - All changes for this request are pending approval.
  • CHANGE_INQUEUE - The change was made on an unverified object and is pending processing of the parent task.
  • CHANGE_PARTIALLYPROCESSED - At least one field change was accepted.
  • CHANGE_PROCESSED - The task was processed and a result issued.
  • CHANGE_CANCELLED - The task was cancelled.
result__v The change request result:
  • CHANGE_ACCEPTED - All changes for this request have been accepted.
  • CHANGE_REJECTED - All changes for this request were rejected.
  • CHANGE_PARTIAL - At least one field change was accepted.
entity_type The entity type of the change request: HCP or HCO.
vid_key The external HCP or HCO vid_key supplied by the client in the original change request.
vid__v The ID of the entity: HCP or HCO.
resolution_notes An array of comments containing notes added during change request processing.
  • comment - Notes added by the Network user.
  • fields - An array of fields for which the comments were made.
  • created_date - The date the resolution notes were added by the Network user.
  • code - The code or identifier of the note. Null if the resolution note is not defined.
created_date The creation date of the change request. The date uses the ISO8601 standard.
completed_date The completed date for the change request. If the change request is not completed, this value is empty. The date format uses the ISO8601 standard.
parent_task_ids List of parent task IDs.
errors Errors in retrieving the requested change requests.
Field results
CHANGE_ACCEPTED The change for this field has been accepted.
CHANGE_REJECTED The change for this field has been rejected.
CHANGE_MODIFIED The change for this field has been accepted with differences.
CHANGE_ALREADYAPPLIED The change for this field has been already applied.
CHANGE_ADDED The change for this field was added to the change request after creation.
Child object attributes
vid_key The external vid_key supplied by the client in the original change request.
vid__v The Network ID of the entity.
field The Network API name of the entity’s field for the HCP or HCO.
  • change_requested - The value of the requested change.
  • final_value - The new value of the field.
  • result -
    • CHANGE_ACCEPTED - The change for this field has been accepted.
    • CHANGE_REJECTED - The change for this field has been rejected .
    • CHANGE_MODIFIED - The change for this field has been accepted with differences .
    • CHANGE_ALREADYAPPLIED - The change for this field has been already applied.
    • CHANGE_ADDED - The change for this field was added to the change request after creation.

Notes

Changelog

Batch retrieve change requests

Sample request

curl -i -H "Authorization: 57696C6C205261...6368204C6F7368" -H "Content-type: application/json" -X POST -d "@dcrs_postdata.json" 'https://my.veevanetwork.com/api/v21.0/change_requests/batch'

Sample POST data

{
  "change_requests":[
   {
    "change_request_id":"527723033129911296"
   },
   {
    "change_request_id":"493664636982264832"
   }
  ]
}

Sample response

{
  "responseStatus": "SUCCESS",
  "change_requests": [
    {
      "metadata": {
        "creator": "john.smith@my.veevanetwork.com",
        "note": "Customer Master changes applied",
        "source": "Entity Profile Editor",
        "system": "ERP1"
      },
      "entity": {
        "specialty_2__v": {
          "change_requested": "MT",
          "final_value": null,
          "result": "CHANGE_REJECTED"
        },
        "external_custom_keys": [
          "ERP1:HCP:654321"
        ]
      },
      "taskCountry": "US",
      "task_type": "CHANGE_REQUEST",
      "original_task_type": "CHANGE_REQUEST",
      "change_request_id": "493664636982264832",
      "status__v": "CHANGE_PROCESSED",
      "result__v": "CHANGE_REJECTED",
      "entity_type": "HCP",
      "vid_key": "Network:Entity:462463289150931969",
      "vid__v": "462463289150931969",
      "resolution_notes": [
        {
          "comment": "System Rejected - Can't update an INVALID/MERGED-INTO record",
          "fields": [
            "specialty_2__v"
          ],
          "created_date": "2014-12-15T17:20:09.620-06:00",
          "code": "R-10001"
        }
      ],
      "created_date": "2014-10-08T16:38:47.000-05:00",
      "completed_date": "2014-12-15T17:20:11.000-06:00"
    },
    {
      "metadata": {
        "creator": "john.smith@my.veevanetwork.com",
        "note": "Customer Master changes applied",
        "source": "Entity Profile Editor",
        "system": null
      },
      "entity": {
        "external_custom_keys": [
          "ERP1:HCP:987654"
        ],
        "parent_hcos__v": [
          {
            "vid_key": "Network:ParentHCO:477715384619762691",
            "vid__v": "477715384619762691",
            "object_id": "527723032584651776",
            "is_primary_relationship__v": {
              "change_requested": "N",
              "final_value": null,
              "result": null
            },
            "external_custom_keys": [
              "ERP1:PARENTHCO:123456"
            ]
          }
        ]
      },
      "taskCountry": "US",
      "task_type": "CHANGE_REQUEST",
      "original_task_type": "CHANGE_REQUEST",
      "change_request_id": "527723033129911296",
      "status__v": "CHANGE_PENDINGREVIEW",
      "result__v": null,
      "entity_type": "HCP",
      "vid_key": "Network:Entity:469466290176656385",
      "vid__v": "469466290176656385",
      "resolution_notes": null,
      "created_date": "2014-11-24T15:26:44.000-06:00",
      "completed_date": null
    }
  ]
}

Sample POST data: Retrieve change requests in batch with system name

{
  "change_requests":[
   {
    "change_request_id":"441305647707849728"
   },
   {
    "change_request_id":"441306106715702272"
   }
  ],
  "systemName":"ODS"
}

Sample POST data: Retrieve change requests in batch with status codes

{
  "change_requests":[
   {
    "change_request_id":"441305647707849728"
   },
   {
    "change_request_id":"441306106715702272"
   }
  ],
  "status_codes":[
    "CHANGE_NEW",
    "CHANGE_PENDINGREVIEW"
  ]
}

This API enables you to obtain information about multiple change requests through the API.

Endpoint URL

https://{DNS}/api/{version}/change_requests/batch

POST data
change_requests An array of change request IDs to retrieve:
  • change_request_id - The ID of the change request generated in Network.
systemName Return target aliases specified for this system as well as the external customer keys associated to it. If a system is not provided, Network will return default reference value codes and empty external custom keys.
status_codes A list of status codes.
  • The change request was received and processed but is pending review by data stewards or another upstream source.
  • The change request is made on an unverified object and is pending parent task processing.
  • The change request was partially processed by master or customer data stewards.
  • The change request was processed and a result issued.
  • The change request was cancelled.
includeEntity Return the full entity or entities related to the requested change requests. An entity for a change request is determined from the entity identifier (vid__v) of the change request.
sinceDate Include change requests modified after the specified date (exclusive). This value is specified in epoch time in milliseconds.
toDate Include change requests modified on or before the specified date (inclusive). This value is specified in epoch time in milliseconds.
Response
responseStatus

The status of the response in Network.

change_requests An array of change requests. See the Change request response attributes table for details.
entities An array of entities associated with the change requests. Each entity is related to a change request through the vid__v field.

Changelog

Update change request

Sample request

curl -i -H "Authorization: 57696C6C205261...6368204C6F7368" -H "Content-type: application/json" -X PUT -d "@dcrs_postdata.json" 'https://my.veevanetwork.com/api/v21.0/change_request'

Sample PUT data

{
  "metadata": {
    "creator": "john.smith@my.veevanetwork.com",
    "note": "New record added via API.",
    "system": "ERP1"
  },
  "entity": {
    "hcp_type__v": {
      "change_requested": "P",
      "final_value": null,
      "result": "CHANGE_ACCEPTED"
    },
    "first_name__v": {
      "change_requested": "Charlie",
      "final_value": null,
      "result": "CHANGE_ACCEPTED"
    },
    "last_name__v": {
      "change_requested": "Brown",
      "final_value": null,
      "result": "CHANGE_ACCEPTED"
    },
    "hcp_status__v": {
      "change_requested": "A",
      "final_value": null,
      "result": "CHANGE_ACCEPTED"
    },
    "medical_degree_1__v": {
      "change_requested": "MD",
      "final_value": null,
      "result": "CHANGE_ACCEPTED"
    },
    "specialty_1__v": {
      "change_requested": "IM",
      "final_value": null,
      "result": "CHANGE_ACCEPTED"
    },
    "primary_country__v": {
      "change_requested": "US",
      "final_value": null,
      "result": "CHANGE_ACCEPTED"
    },
    "gender__v": {
      "change_requested": "M",
      "final_value": null,
      "result": "CHANGE_ACCEPTED"
    },
    "master_keys": [
      "master_source:HCP:997200002"
    ]
  },
  "taskCountry": "US",
  "task_type": "CHANGE_REQUEST",
  "original_task_type": "CHANGE_REQUEST",
  "change_request_id": "542116772438868992",
  "status__v": "CHANGE_NEW",
  "result__v": "CHANGE_PENDING",
  "entity_type": "HCP",
  "vid_key": null,
  "vid__v": null,
  "resolution_notes": null,
  "created_date": "2014-10-08T09:54:55.000-04:00",
  "completed_date": null,
  "job_ids": [
    "486"
  ],
  "comment": "All fields updated through load"
}

Sample response

 {
    "responseStatus": "SUCCESS",
    "change_requests": [
        {
            "responseStatus": "SUCCESS",
            "change_request_id": "542116772438868992"
        }
    ]
}

This API enables you to update an unprocessed change request through the API.

Endpoint URL

https://{DNS}/api/{version}/change_request

This API takes no parameters.

PUT data
system The name of a valid system in Network.
result
  • CHANGE_ACCEPTED - All changes for this request have been accepted.
  • CHANGE_REJECTED - No changes for this request were accepted.
  • CHANGE_MODIFIED - The change for this field has been accepted with differences.
  • CHANGE_ALREADYAPPLIED - The change for this field has already been applied.
master_keys This parameter is only required if you are updating a change request from a third-party master. It is an array of external keys to identify the entity and each of the child objects (addresses, licenses, parent HCOs).

The key format is the three-part format used by vid_key, consisting of source type (typically the name of the system used to load the master data), item type, and value, separated by colons.

The master keys are essential to link the entity and child objects in the change request to the entity loaded through a subscription job.
taskCountry The country code of the change request.
change_request_id The ID of the change request generated in Network.
job_ids A list of IDs of source subscription jobs used to load the entity in this change request. Upon processing, the final values of the fields of the entity will be obtained from the entity loaded through jobs.
comment A comment about the feedback related to the change request update. The comment will be transfer to the resolution notes after each update.
Response
responseStatus The status of the response in Network.
change_requests
  • The response status confirming the success of the operation.
  • The change request ID.
errors An array of errors

Notes

Not all fields in the change requests can be updated by the integrator system; however, those fields can be provided during the update and Network will ignore them.

Batch update change requests

Sample request

curl -i -H "Authorization: 57696C6C205261...6368204C6F7368" -H "Content-type: application/json" -X PUT -d "@dcrs_postdata.json" 'https://my.veevanetwork.com/api/v21.0/change_request/batch'

Sample PUT data

{
  "change_requests": [
    {
      "metadata": {
        "creator": "john.smith@my.veevanetwork.com",
        "note": "New record added via API.",
        "system": "ERP1"
      },
      "entity": {
        "hcp_type__v": {
          "change_requested": "P",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "first_name__v": {
          "change_requested": "Marvin",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "last_name__v": {
          "change_requested": "Gaye",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "hcp_status__v": {
          "change_requested": "A",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "medical_degree_1__v": {
          "change_requested": "MD",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "specialty_1__v": {
          "change_requested": "IM",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "primary_country__v": {
          "change_requested": "US",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "gender__v": {
          "change_requested": "M",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "master_keys": [
          "master_source:HCP:997200012"
        ]
      },
      "taskCountry": "US",
      "change_request_id": "543667922896159744",
      "status__v": "CHANGE_PARTIALLYPROCESSED",
      "result__v": null,
      "entity_type": "HCP",
      "vid_key": null,
      "vid__v": null,
      "resolution_notes": null,
      "created_date": "2014-11-06T08:49:33.000-05:00",
      "completed_date": null,
      "job_ids": [
        "504"
      ],
      "comment": "All fields updated through master data load"
    },
    {
      "metadata": {
        "creator": "john.smith@my.veevanetwork.com",
        "note": "New record added via API.",
        "source": "API"
      },
      "entity": {
        "hcp_type__v": {
          "change_requested": "P",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "first_name__v": {
          "change_requested": "Nigella",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "last_name__v": {
          "change_requested": "Lam",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "hcp_status__v": {
          "change_requested": "A",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "medical_degree_1__v": {
          "change_requested": "MD",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "specialty_1__v": {
          "change_requested": "IM",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "primary_country__v": {
          "change_requested": "US",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "gender__v": {
          "change_requested": "M",
          "final_value": null,
          "result": "CHANGE_ACCEPTED"
        },
        "master_keys": [
          "master_source:HCP:997200013"
        ]
      },
      "taskCountry": "US",
      "change_request_id": "542116772438868992",
      "status__v": "CHANGE_PARTIALLYPROCESSED",
      "result__v": null,
      "entity_type": "HCP",
      "vid_key": null,
      "vid__v": null,
      "resolution_notes": null,
      "created_date": "2014-11-06T08:49:33.000-05:00",
      "completed_date": null,
      "job_ids": [
        "504"
      ],
      "comment": "All fields updated through master data load"
    }
  ]
}

Sample response

 {
    "responseStatus": "SUCCESS",
    "change_requests": [
        {
            "responseStatus": "SUCCESS",
            "change_request_id": "543667922896159744"
        },
        {
            "responseStatus": "SUCCESS",
            "change_request_id": "542116772438868992"
        }
    ]
}

This API enables you to update multiple unprocessed change requests through the API.

Endpoint URL

https://{DNS}/api/{version}/change_request/batch

This API takes no parameters.

PUT data
system The name of a valid system in Network.
result
  • All changes for this request have been accepted.
  • No changes for this request were accepted.
  • The change for this field has been accepted with differences.
  • The change for this field has already been applied.
master_keys This parameter is only required if you are updating a change request from a third-party master. It is an array of external keys to identify the entity and each of the child objects (addresses, licenses, parent HCOs). The key format is the three-part format used by vid_key, consisting of source type (typically the name of the system used to load the master data), item type, and value, separated by colons. The master keys are essential to link the entity and child objects in the change request to the entity loaded through a subscription job.
taskCountry The country code of the change request.
change_request_id The ID of the change request generated in Network.
job_ids A list of IDs of source subscription jobs used to load the entity in this change request. Upon processing, the final values of the fields of the entity will be obtained from the entity loaded through jobs.
comment A comment about the feedback related to the change request update. The comment will be transfer to the resolution notes after each update.
Response
responseStatus

The status of the response in Network.

change_requests
  • The response status confirming the success of the operation.
  • The change request ID.
errors An array of errors.

Process change request

Sample request

curl -X PUT -H "Content-Type: application/json" -d '{}' -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com//api/v21.0/change_request/process/935201059206140415'

Sample PUT data

{
  "change_requests": [
    {
      "change_request_id": "543667922896159744"
    },
    {
      "change_request_id": "542116772438868992"
    }
  ],
  "systemName": "ERP1"
}

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to process an unprocessed change request through the API.

Endpoint URL

https://{DNS}/api/{version}/change_request/process/{change_request_id}

Parameters
change_request_id The ID of the change request generated in Network.
systemName Return target aliases specified for this system as well as the external customer keys associated to it. If a system is not provided, Network will return default reference value codes and empty external custom keys.
Response
responseStatus The status of the response in Network.

Batch process change requests

Sample request

curl -i -H "Authorization: 57696C6C205261...6368204C6F7368" -H "Content-type: application/json" -X PUT -d "@dcrs_postdata.json" 'https://my.veevanetwork.com/api/v21.0/change_request/process/batch'

Sample PUT data

{
  "change_requests": [
    {
      "change_request_id": "543667922896159744"
    },
    {
      "change_request_id": "542116772438868992"
    }
  ],
  "systemName": "ERP1"
}

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to process multiple unprocessed change requests through the API.

Endpoint URL

https://{DNS}/api/{version}/change_request/process/batch

This API takes no parameters.

PUT data
change_requests An array of change request IDs:
  • change_request_id - The ID of the change request generated in Network.
systemName Return target aliases specified for this system as well as the external customer keys associated to it. If a system is not provided, Network will return default reference value codes and empty external custom keys.
Response
responseStatus The status of the response in Network.

Batch reject change request

Sample request

curl -i -H "Authorization: 57696C6C205261...6368204C6F7368" -H "Content-type: application/json" -X PUT -d "@dcrs_postdata.json" 'https://my.veevanetwork.com/api/v21.0/change_request/reject/batch'

Sample PUT data

{
  "change_requests": [
    {
      "change_request_id": "543667922896159744"
    },
    {
      "change_request_id": "542116772438868992",
      "comment": "This comment overwrites the resolution notes template.",
      "code": "R-00010"
    }
  ],
  "systemName": "ERP1"
}

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to bulk reject up to 500 change requests.

Endpoint URL

https://{DNS}/api/{version}/change_request/reject/batch

This API takes no parameters.

PUT data
change_requests An array of change request IDs:
  • change_request_id - The ID of the change request generated in Network.
  • code - A custom resolution code to add to the resolution notes.
  • comment - A comment to add to the resolution notes.
systemName Return target aliases specified for this system as well as the external customer keys associated to it. If a system is not provided, Network will return default reference value codes and empty external custom keys.
Response
responseStatus The status of the response in Network.

Notes

Only change requests that are pending review can be rejected in batch.

Batch approve change request

Sample request

curl -i -H "Authorization: 57696C6C205261...6368204C6F7368" -H "Content-type: application/json" -X PUT -d "@dcrs_postdata.json" 'https://my.veevanetwork.com/api/v21.0/change_request/approve/batch'

Sample PUT data

{
  "change_requests": [
    {
      "change_request_id": "543667922896159744"
    },
    {
      "change_request_id": "542116772438868992",
      "comment": "This comment overwrites the resolution notes template.",
      "code": "R-00010"
    }
  ],
  "systemName": "ERP1"
}

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to bulk approve up to 500 change requests.

Endpoint URL

https://{DNS}/api/{version}/change_request/approve/batch

This API takes no parameters.

PUT data
change_requests An array of change request IDs:
  • change_request_id - The ID of the change request generated in Network.
  • code - A custom resolution code to add to the resolution notes.
  • comment - A comment to add to the resolution notes.
systemName Return target aliases specified for this system as well as the external customer keys associated to it. If a system is not provided, Network will return default reference value codes and empty external custom keys.
Response
responseStatus The status of the response in Network.

Sample request:
Search on requests with a task status of NEW for US records

curl -X GET -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/change_request/search?offset=0&filters=task_status:NEW~task_country:US'

Sample response:
Search on requests with a task status of NEW for US records

{
   "offset" : 0,
   "change_requests" : [
      {
         "vid__v" : "242979820290442251",
         "entity_type" : "HCP",
         "completed_date" : null,
         "status__v" : "CHANGE_PENDINGREVIEW",
         "taskCountry" : "US",
         "change_request_id" : "928804073117519007",
         "vid_key" : "Network:Entity:242979820290442251",
         "reserved_vid" : null,
         "metadata" : {
            "note" : "Customer Master changes applied",
            "system" : null,
            "creator" : "john.smith@my.veevanetwork.com",
            "source" : "Entity Profile Editor"
         },
         "parent_task_ids" : [],
         "created_date" : "2016-08-15T15:04:40.000-07:00",
         "entity" : {
            "specialty_1__v" : {
               "final_value" : null,
               "result" : null,
               "change_requested" : "UCM"
            }
         },
         "result__v" : null,
         "original_task_type" : "CHANGE_REQUEST",
         "task_type" : "CHANGE_REQUEST",
         "resolution_notes" : null
      },
      {
         "parent_task_ids" : [],
         "metadata" : {
            "source" : "Entity Profile Editor",
            "creator" : "john.smith@my.veevanetwork.com",
            "system" : null,
            "note" : "address update. he no longer works there"
         },
         "created_date" : "2016-08-22T10:00:17.000-07:00",
         "original_task_type" : "CHANGE_REQUEST",
         "result__v" : null,
         "entity" : {
            "addresses__v" : [
               {
                  "postal_code__v" : {
                     "result" : null,
                     "change_requested" : "15243-1317",
                     "final_value" : null
                  },
                  "object_id" : "928842512290483360",
                  "country__v" : {
                     "final_value" : null,
                     "result" : null,
                     "change_requested" : "US"
                  },
                  "vid_key" : "Network:Address:243244004181804041",
                  "locality__v" : {
                     "final_value" : null,
                     "change_requested" : "Pittsburgh",
                     "result" : null
                  },
                  "vid__v" : "243244004181804041",
                  "address_line_3__v" : {
                     "final_value" : null,
                     "result" : null,
                     "change_requested" : null
                  },
                  "administrative_area__v" : {
                     "change_requested" : "US-PA",
                     "result" : null,
                     "final_value" : null
                  },
                  "address_line_2__v" : {
                     "change_requested" : null,
                     "result" : null,
                     "final_value" : null
                  },
                  "address_line_1__v" : {
                     "final_value" : null,
                     "change_requested" : "277 Dupont Cir",
                     "result" : null
                  }
               }
            ]
         },
         "resolution_notes" : null,
         "task_type" : "CHANGE_REQUEST",
         "entity_type" : "HCP",
         "vid__v" : "242979820290442251",
         "change_request_id" : "928842512431123615",
         "vid_key" : "Network:Entity:242979820290442251",
         "taskCountry" : "US",
         "status__v" : "CHANGE_PENDINGREVIEW",
         "completed_date" : null,
         "reserved_vid" : null
      }
   ],
   "totalCount" : 268,
   "responseStatus" : "SUCCESS",
   "limit" : 2
}

Sample request: Search on requests between specified dates

curl -X GET -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/change_request/search?filters=range||created_at:1403531171000||1406123171000'

Sample request:
Search on requests from a specified date to the current date

curl -X GET -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/change_request/search?filters=range||created_at:1403531171000'

Sample request: Search on requests created before the last 48 hours

curl -X GET -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/change_request/search?rangeDiff||created_at:||48'

This API enables you to retrieve all change requests that match a specified search criteria.

Endpoint URL

https://{DNS}/api/{version}/change_request/search

Optional parameters
q The text for the search query. Uses the following fields:
  • subject
  • description
  • summary
  • task_type
  • task_data
  • comment
offset The first record to retrieve from the offset specified. The default value is 0.
limit The number to limit the results returned. The default is 10; the maximum is 100.
sort The attribute to sort results by; for example, task_type.
sortOrder The sort order: asc for ascending or desc for descending.
filters Filters for refining the results. See the Search Filters table for more information.
systemName When provided, Network returns target alias values defined for reference codes for this system. Otherwise, Network returns default reference code values.
masterSystemNames A comma-separated list of master system names. Search results will include only change requests that are handled by the specified master systems. Includes all pending and processed change requests.
pendingMasterSystemNames A comma-separated list of master system names. Search results will include only change requests that are awaiting processing by the specified master systems.
Search filters
task_type The change request type:
  • ADD_REQUEST - An add request submitted on an existing record in Network.
  • CHANGE_REQUEST - A change request for a new record in Network
task_status The status of the task:
  • NEW - A new task has been received but not run yet.
  • IN_PROGRESS - A task is pending approval by a master or customer master data steward.
  • CLOSED - A task has been closed.
task_country The country to which the task belongs.
task_state The state of the task:
  • NEW - A new task has been received but not run yet.
  • PENDINGREVIEW - A task was received and processed but is pending review by data stewards or another upstream source.
  • CANCELLED - The task was cancelled.
  • FAILED - The task failed due to an unexpected error.
  • PROCESSED - The task was processed and a result issued.
  • PROCESSING - The task is being processed.
resolution The resolution for the task:
  • CHANGE_PENDING - All changes for this request are pending approval.
  • CHANGE_ACCEPTED - All changes for this request have been accepted.
  • CHANGE_REJECTED - All changes for this request were rejected.
  • CHANGE_PARTIAL - At least one field change was accepted.
created_at The date the task was created.
created_by The ID of the user that generated the change request.
creator The user name of the user that generated the change request.
completed_at The completed date of the task. Is empty if the change request is not completed. Date format is ISO8601 standard.
completed_by The ID of the user that approved the task.
open The task is open: True or False.
system The name of the system that generated the task. This is used for reference aliases and other validation.
entity_type The entity type for the task: HCP or HCO.
entity_id The Veeva Network entity ID.
owner The ID of the owner of the task.

Note: Filter values passed in from a GET request need to be URL-encoded.

Response
responseStatus The status of the response in Network.
totalCount The total number of search results, regardless of the set limit.
offset The first record to retrieve from the offset specified. The default value is 0.
limit The number provided to limit the search results.
change_requests An array of change requests. See the Change request response attributes table for details.

Changelog

Version 7.0 responses included master_keys, external_custom_keys (if systemName provided), task_type, and original_task_type for easier downstream integration.

Change request match

Sample requests

curl -X POST -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/change_request/match/542116772438868992?vidKey=847328898944336896'

Sample response

{
   "responseStatus": "SUCCESS",
   "change_request_id": 542116772438868992
}

This API enables you to match a request to an existing entity. You can use either the Veeva ID or custom key of an existing entity to match the request against.

Endpoint URL

https://{DNS}/api/{version}/change_request/match/{change_request_id}

Parameters
vidKey The key for the object.
comment Notes added by the Network user.
Response
responseStatus The status of the response in Network.
change_request_id The ID of the change request.

Notes

Batch process suspect match

Sample request: Reject suspect match

curl -i -H "Authorization: 57696C6C205261...6368204C6F7368" -H "Content-type: application/json" -X PUT -d "@match_postdata.json" 'https://my.veevanetwork.com/api/v21.0/suspect-match/process/batch'

Sample PUT data: Reject suspect match

{
   "suspect_matches":[
      {
         "task_id":"929058362287521823",
         "comment":"Rejected suspect match"
      }
   ]
}

Sample response: Reject suspect match

{
   "responseStatus": "SUCCESS",
   "suspect_matches": [
      {
         "responseStatus": "SUCCESS",
         "task_id": "929058346986962975"
      }
   ]
}

Sample PUT data: Accept suspect match

{
   "suspect_matches":[
      {
         "task_id":"929058346986962975",
         "comment":"Accepted suspect match",
         "match_entities":[
            {
               "source_entity_id":"928729167160023840",
               "target_entity_id":"928729206350945055"
            }
         ]
      }
   ]
}

This API enables enables you to process multiple unprocessed suspect matches.

Endpoint URL

https://{DNS}/api/{version}/suspect-match/process/batch

This API takes no parameters.

PUT data
task_id

The ID of a suspect match to process.

match_entities The pairs of entities to match. Leave empty to reject the suspect match.
source_entity_id The ID of the entity to be merged.
target_entity_id The ID of the entity that the match will be merged into.
comment The resolution note to apply.
Response
responseStatus The status of the response in Network.
suspect_matches An array of suspect_matches that correspond to the same objects in the request.
  • The status of a processed suspect match.
  • The ID of a processed suspect match.

Notes

Batch create suspect match

Sample request

curl -i -H "Authorization: 57696C6C205261...6368204C6F7368" -H "Content-type: application/json" -X POST -d "@matches_postdata.json" 'https://my.veevanetwork.com/api/v21.0/entity/createSuspectMatch/batch'

Sample POST data

{
    "suspect_matches": [{
            "metadata": {
                "note": "",
                "creator": "John Smith"
            },
            "vid_key": "Network:Entity:242980101568857107",
            "matching_vid_key": "Network:Entity:242980097970144256"
        }, {
            "metadata": {
                "note": "",
                "creator": "John Smith"
            },
            "vid_key": "Network:Entity:932020953046843423",
            "matching_vid_key": "Network:Entity:847332072480572416"
        }
    ]
}

Sample response: Partial success

{
   "suspect_matches" : [
      {
         "suspect_match_id" : "936109874024288767"
      }
   ],
   "errorType" : "UNEXPECTED_ERROR",
   "responseStatus" : "PARTIAL_SUCCESS",
   "errors" : [
      {
         "type" : "UNEXPECTED_ERROR",
         "message" : "No entity found with the given Id Network:Entity:847332072480572416"
      }
   ]
}

This API enables enables you to create multiple suspect matches.

Endpoint URL

https://{DNS}/api/{version}/entity/createSuspectMatch/batch

This API takes no parameters.

POST data
vid_key

The vid_key of the entity to be merged.

matching_vid_key The vid_key of the entity to match.
metadata Details about the request. These details are stored in the entity history if the change is accepted.
  • creator - The name of the user that generated the request.
  • note - Details about the request.
  • source - Additional information about the source of the request.
Response
responseStatus

The status of the response in Network.

suspect_matches An array of suspect_matches that correspond to the same objects in the request.
  • The ID of a processed suspect match.

Notes

Batch reject suspect match

Sample request

curl -i -H "Authorization: 57696C6C205261...6368204C6F7368" -H "Content-type: application/json" -X POST -d "@matches_postdata.json" 'https://my.veevanetwork.com/api/v21.0/suspect_match/reject/batch'

Sample POST data

{
  "suspect_matches": [
    {
      "suspect_match_id": "936109874024288767"
    },
    {
      "suspect_match_id": "932218031792324671"
    }
    ]
}

Sample response: Partial success

{
   "errors" : [
      {
         "message" : "Suspect Match Task 936109874024288767 not found",
         "type" : "INVALID_DATA"
      }
   ],
   "suspect_matches" : [
      {
         "created_date" : "2018-08-05T02:20:41.000-07:00",
         "id" : 932876752875559711,
         "state" : "PENDINGREVIEW",
         "suspect_match_results" : [
            {
               "merge_into_vid" : 242980103305298946,
               "surviving_entity_vid" : 929642136033361951
            }
         ]
      }
   ],
   "responseStatus" : "PARTIAL_SUCCESS"
}

This API enables enables you to reject multiple suspect match tasks.

Endpoint URL

https://{DNS}/api/{version}/suspect_match/reject/batch

This API takes no parameters.

POST data
suspect_match_ids An array of suspect match IDs.
Response
responseStatus The status of the response in Network.
suspect_matches An array of suspect_matches that correspond to the same objects in the request.
  • The ID of a processed suspect match.

Notes

Batch retrieve suspect match

Sample request

curl -i -H "Authorization: 57696C6C205261...6368204C6F7368" -H "Content-type: application/json" -X POST -d "@matches_postdata.json" 'https://my.veevanetwork.com/api/v21.0/suspect_match/batch'

Sample POST data

{
  "suspect_matches": [
    {
      "suspect_match_id": "931697085670096927"
    },
    {
      "suspect_match_id": "931697013151105055"
    },
    {
      "suspect_match_id": "932218057214525503"
    }
    ]
}

Sample response: Partial success

{
    "responseStatus": "PARTIAL_SUCCESS",
    "errors": [
        {
            "type": "INVALID_DATA",
            "message": "Suspect Match Task 931697085670096927 not found"
        },
        {
            "type": "INVALID_DATA",
            "message": "Suspect Match Task 931697013151105055 not found"
        }
    ],
    "suspect_matches": [
        {
            "id": 932218057214525503,
            "resolution": "NOT_MATCHED",
            "state": "PROCESSED",
            "created_date": "2018-04-10T11:25:43.000-07:00",
            "completed_date": "2018-04-10T11:27:31.000-07:00",
            "suspect_match_results": [
                {
                    "merge_into_vid": 847332072463795200,
                    "surviving_entity_vid": null
                }
            ]
        }
    ]
}_

This API enables enables you to retrieve information about multiple suspect matches.

Endpoint URL

https://{DNS}/api/{version}/suspect_match/batch

POST data
suspect_match_ids An array of suspect match IDs.
Response
responseStatus The status of the response in Network.
suspect_matches An array of suspect_matches that correspond to the same objects in the request.
  • id - The ID of the retrieved suspect match task.
  • resolution_note - The notes added for the suspect match task.
  • created_date - The date the task was created.
  • completed_date - The date the task was completed.
  • resolution - The resolution of the task.
  • state - The state of the task.
  • suspect_match_results - Result of suspect match showing the the entity which is merged into the surviving entity.
    • merge_into_vid - The Network ID of the entity merged into the surviving entity.
    • surviving_entity_vid - The Network ID of the surviving entity.

Notes

Retrieve entities

This API enables you to obtain information about any entity or child entity (addresses, licenses, and parent HCOs), including custom keys for the entities retrieved.

Retrieve entity

Sample request

curl -X GET -H "Authorization: 57696C6C205261...6368204C6F7368" https://my.veevanetwork.com/api/v21.0/entity/932671707694238303

Sample response

{
   "entities" : [
      {
         "entity" : {
            "vid__v" : "932671707694238303",
            "last_name__v" : "Smith",
            "status_update_time__v" : "2018-06-29T14:15:00.000Z",
            "licenses__v" : [
               {
                  "expiration_date__v" : "2013-12-31",
                  "custom_keys__v" : [],
                  "entity_vid__v" : "932671707694238303",
                  "license_number__v" : "1256987",
                  "license_status__v" : "A",
                  "primary_license__c" : "U",
                  "record_state__v" : "VALID",
                  "record_delta_id__v" : "932671707821604865",
                  "record_owner_name__v" : "Local",
                  "effective_date__v" : "2010-05-05",
                  "address_vid__v" : "932671707694238304",
                  "modified_date__v" : "2018-06-29T14:15:02.000Z",
                  "is_veeva_master__v" : false,
                  "license_status_condition__v" : "0",
                  "record_owner_type__v" : "LOCAL",
                  "created_date__v" : "2018-06-29T14:15:00.000Z",
                  "body__v" : "ALMD",
                  "entity_type__v" : "HCP",
                  "status_update_time__v" : "2018-06-29T14:15:00.000Z",
                  "license_subtype__v" : "U",
                  "vid__v" : "932671707694238305"
               }
            ],
            "specialty_1_rank__v" : 1,
            "created_date__v" : "2018-06-29T14:15:00.000Z",
            "specialty_1__v" : "AC",
            "record_owner_type__v" : "LOCAL",
            "hcp_type__v" : "P",
            "ama_do_not_contact__v" : "N",
            "is_veeva_master__v" : false,
            "hcp_status__v" : "A",
            "kaiser__v" : "N",
            "pdrp_optout__v" : "N",
            "modified_date__v" : "2018-06-29T14:15:02.000Z",
            "record_version__v" : 1,
            "primary_country__v" : "US",
            "first_name__v" : "James",
            "record_owner_name__v" : "Local",
            "record_delta_id__v" : "932671707842248703",
            "fellow__v" : "N",
            "gender__v" : "M",
            "record_state__v" : "VALID",
            "formatted_name__v" : "James Smith",
            "parent_hcos__v" : [],
            "grad_training__v" : "N",
            "addresses__v" : [
               {
                  "premise_number__v" : "326",
                  "latitude__v" : 46.815034,
                  "postal_code_primary__v" : "58501",
                  "ISO_3166_3__v" : "USA",
                  "thoroughfare_trailing_type__v" : "DR",
                  "delivery_address_1__v" : "326 Harolds DR",
                  "record_state__v" : "VALID",
                  "record_owner_name__v" : "Local",
                  "address_status__v" : "A",
                  "address_line_1__v" : "326 Harolds Drive",
                  "longitude__v" : -100.774784,
                  "country__v" : "US",
                  "ISO_3166_n__v" : "840",
                  "created_date__v" : "2018-06-29T14:15:00.000Z",
                  "vid__v" : "932671707694238304",
                  "administrative_area__v" : "US-ND",
                  "locality__v" : "BISMARCK",
                  "custom_keys__v" : [],
                  "thoroughfare__v" : "Harolds DR",
                  "premise__v" : "326",
                  "thoroughfare_name__v" : "Harolds",
                  "entity_vid__v" : "932671707694238303",
                  "record_delta_id__v" : "932671707821604864",
                  "address_type__v" : "P",
                  "modified_date__v" : "2018-06-29T14:15:02.000Z",
                  "address_ordinal__v" : 1,
                  "is_veeva_master__v" : false,
                  "entity_type__v" : "HCP",
                  "record_owner_type__v" : "LOCAL",
                  "formatted_address__v" : "326 Harolds DR BISMARCK ND 58501",
                  "postal_code__v" : "58501",
                  "delivery_address__v" : "326 Harolds DR",
                  "status_update_time__v" : "2018-06-29T14:15:00.000Z",
                  "address_verification_status__v" : "DS"
               }
            ],
            "custom_keys__v" : [
               {
                  "vid__v" : "932671707717372511",
                  "custom_key_source_type__v" : "CUSTOMER__v/3/change_request",
                  "custom_key_value__v" : "932671707694238303",
                  "status_update_time__v" : "2018-06-29T14:15:00.000Z",
                  "custom_key_entity_type__v" : "HCP",
                  "custom_key_vid_key__v" : "CUSTOMER__v/3/change_request:HCP:932671707694238303",
                  "custom_key_entity_id__v" : "932671707694238303",
                  "created_date__v" : "2018-06-29T14:15:00.000Z",
                  "custom_key_item_type__v" : "HCP",
                  "custom_key_status__v" : "A",
                  "modified_date__v" : "2018-06-29T14:15:00.000Z"
               },
               {
                  "modified_date__v" : "2018-06-29T14:15:00.000Z",
                  "vid__v" : "932671707718093407",
                  "custom_key_source_type__v" : "WORKFLOW__v",
                  "custom_key_value__v" : "932671707570838463",
                  "status_update_time__v" : "2018-06-29T14:15:00.000Z",
                  "custom_key_vid_key__v" : "WORKFLOW__v:DCRID__v:932671707570838463",
                  "custom_key_entity_id__v" : "932671707694238303",
                  "custom_key_entity_type__v" : "HCP",
                  "custom_key_status__v" : "A",
                  "custom_key_item_type__v" : "DCRID__v",
                  "created_date__v" : "2018-06-29T14:15:00.000Z"
               }
            ],
            "is_externally_mastered__v" : false
         },
         "entityType" : "HCP",
         "metaData" : {},
         "entityId" : "932671707694238303"
      }
   ],
   "responseStatus" : "SUCCESS"
}

Sample response (custom objects)

{
    "responseStatus": "SUCCESS",
    "entities": [
        {
            "entityId": "933580259012116863",
            "entityType": "EMPLOYEE__C",
            "metaData": {},
            "entity": {
                "employee_title__c": "Key Account Manager",
                "record_owner_type__v": "LOCAL",
                "employee_status__c": "A",
                "employee_business_unit__c": "Sales",
                "employee_number__c": "103",
                "employee_last_name__c": "Carter",
                "record_delta_id__v": "933580259060776959",
                "record_owner_name__v": "Local",
                "employee_name__c": "Daniel Carter",
                "primary_country__v": "US",
                "created_date__v": "2018-12-07T08:11:33.000Z",
                "employee_first_name__c": "Daniel",
                "employee_hire_date__c": "2018-12-01",
                "is_veeva_master__v": false,
                "status_update_time__v": "2018-12-07T08:11:33.000Z",
                "modified_date__v": "2018-12-07T08:11:33.000Z",
                "record_state__v": "VALID",
                "candidate_record__v": false,
                "record_version__v": 0,
                "vid__v": "933580259012116863",
                "is_externally_mastered__v": false,
                "custom_keys__v": [
                    {
                        "custom_key_entity_id__v": "933580259012116863",
                        "custom_key_item_type__v": "EMPLOYEE__C",
                        "custom_key_value__v": "933580259012116863",
                        "modified_date__v": "2018-12-07T08:11:33.000Z",
                        "vid__v": "933580259018867071",
                        "custom_key_vid_key__v": "CUSTOMER__v/3/change_request:EMPLOYEE__C:933580259012116863",
                        "custom_key_source_type__v": "CUSTOMER__v/3/change_request",
                        "created_date__v": "2018-12-07T08:11:33.000Z",
                        "custom_key_entity_type__v": "EMPLOYEE__C",
                        "custom_key_status__v": "A",
                        "status_update_time__v": "2018-12-07T08:11:33.000Z"
                    },
                    {
                        "custom_key_entity_id__v": "933580259012116863",
                        "custom_key_item_type__v": "DCRID__v",
                        "custom_key_value__v": "933580258951365023",
                        "modified_date__v": "2018-12-07T08:11:33.000Z",
                        "vid__v": "933580259019194751",
                        "custom_key_vid_key__v": "WORKFLOW__v:DCRID__v:933580258951365023",
                        "custom_key_source_type__v": "WORKFLOW__v",
                        "created_date__v": "2018-12-07T08:11:33.000Z",
                        "custom_key_entity_type__v": "EMPLOYEE__C",
                        "custom_key_status__v": "A",
                        "status_update_time__v": "2018-12-07T08:11:33.000Z"
                    }
                ],
                "addresses__v": [
                    {
                        "nwk_primary_address__c": "Y",
                        "address_line_1__v": "200 Park Blvd.",
                        "record_owner_type__v": "LOCAL",
                        "record_delta_id__v": "933580259020275711",
                        "record_owner_name__v": "Local",
                        "locality__v": "San Diego",
                        "country__v": "US",
                        "created_date__v": "2018-12-07T08:11:33.000Z",
                        "is_veeva_master__v": false,
                        "status_update_time__v": "2018-12-07T08:11:33.000Z",
                        "address_type__v": "P",
                        "entity_type__v": "EMPLOYEE__C",
                        "address_verification_status__v": "DS",
                        "address_status__v": "A",
                        "modified_date__v": "2018-12-07T08:11:33.000Z",
                        "record_state__v": "VALID",
                        "vid__v": "933580259012116864",
                        "entity_vid__v": "933580259012116863",
                        "postal_code__v": "91915",
                        "administrative_area__v": "US-CA",
                        "formatted_address__v": "200 Park Blvd. San Diego US-CA 91915",
                        "address_ordinal__v": 1,
                        "custom_keys__v": []
                    }
                ],
                "employee_account_rel_rel_set__c": [
                    {
                        "employee_account_rel_rel_status__c": "A",
                        "related_entity_type__v": "HCO",
                        "record_owner_type__v": "LOCAL",
                        "status_update_time__v": "2018-12-07T08:11:33.000Z",
                        "related_entity_vid__v": "242976972248974337",
                        "related_entity_name__v": "Kindred Hospital San Diego",
                        "record_delta_id__v": "933580259020275712",
                        "entity_type__v": "EMPLOYEE__C",
                        "record_owner_name__v": "Local",
                        "modified_date__v": "2018-12-07T08:11:33.000Z",
                        "record_state__v": "VALID",
                        "is_primary_relationship__v": "N",
                        "vid__v": "933580259012116865",
                        "entity_vid__v": "933580259012116863",
                        "created_date__v": "2018-12-07T08:11:33.000Z",
                        "is_veeva_master__v": false,
                        "custom_keys__v": []
                    }
                ]
            }
        }
    ]
}

This API enables you to obtain information on any entity without identifying the specific entity type.

This API is only used to retrieve information from Network using the GET method.

Note: This API downloads the record for the specified entity from Veeva OpenData to your customer instance.

Endpoint URL

https://{DNS}/api/{version}/entity/{vid_key}

Optional parameters
systemName When provided, Network returns target alias values defined for reference codes for this system. Otherwise, Network returns default reference code values.
enrichedResults Specifies whether or not to display labels for reference type fields in the results.
resultLanguage Specifies the language to use if the enriched results option is enabled. Uses the IETF BCP 47 language standard.
Response
entities An array of fields and values for each entity.
  • entityId - The Network ID of the entity.
  • entityType - The entity type.
  • metaData - Included for structure only; not applicable for this call.
  • entity - The fields and corresponding values for the entity.
responseStatus The status of the response in Network.

Notes

Changelog

Version 19.0 added the enrichedResults and resultLanguage parameters.

Retrieve child entity

Sample request

curl -X GET -H "Authorization: 7D8BFC55F6367BE7B7C961884303B5C178F8AF62381A81441D298A73DAB6B70B4AADA399F6BAA8E8B362DEAEBC728DF79531B3F612036798BB687365F7B04724115B43D1C0AC358478CACB4BAF209B5D" https://my.veevanetwork.com/api/v21.0/child/Network:License:942671707694238303

Sample response

{
   "entities" : [
      {
         "entityType" : "LICENSE",
         "entity" : {
            "expiration_date__v" : "2020-07-31",
            "rxa_eligible__v" : "E",
            "type_value__v" : "IL",
            "entity_vid__v" : "243230954594763778",
            "license_status__v" : "A",
            "record_owner_type__v" : "VOD",
            "status_update_time__v" : "2018-04-23T17:11:38.000Z",
            "is_veeva_master__v" : true,
            "effective_date__v" : "1994-03-21",
            "modified_date__v" : "2018-04-23T17:11:38.000Z",
            "entity_type__v" : "HCP",
            "is_externally_mastered__v" : false,
            "best_state_license__v" : "Y",
            "primary_license__c" : "U",
            "record_state__v" : "VALID",
            "body__v" : "BOME",
            "grace_period__v" : "2020-07-31",
            "type__v" : "STATE",
            "record_owner_name__v" : "OpenData",
            "license_degree__v" : "MD",
            "vid__v" : "929795469719177128",
            "record_delta_id__v" : "942293027461103628",
            "license_number__v" : "036.088139",
            "initial_board_license_date__v" : "2017-07-27",
            "anticipated_expiry_date__v" : "2021-01-27",
            "license_subtype__v" : "U",
            "license_eligibility__v" : "E",
            "created_date__v" : "2018-04-23T17:11:38.000Z",
            "dea_business_activity_code__v" : "ZZ",
            "license_status_condition__v" : "0"
         },
         "entityId" : "929795469719177128",
         "metaData" : {}
      }
   ],
   "responseStatus" : "SUCCESS"
}

This API enables you to obtain information on any child entity (such as address or license) without identifying the specific entity type.

This API is only used to retrieve information from Network using the GET method.

Endpoint URL

https://{DNS}/api/{version}/child/{vid_key}

Optional parameters
systemName When provided, Network returns target alias values defined for reference codes for this system. Otherwise, Network returns default reference code values.
enrichedResults Specifies whether or not to display labels for reference type fields in the results.
resultLanguage Specifies the language to use if the enriched results option is enabled. Uses the IETF BCP 47 language standard.
Response
entities An array of fields and values for each entity:
  • entityId - The Network ID of the entity.
  • entityType - The entity type.
  • metaData - Included for structure only; not applicable for this call.
  • entity - The fields and corresponding values for the entity.
responseStatus The status of the response in Network.

Notes

Changelog

Version 19.0 added the enrichedResults and resultLanguage parameters.

Batch retrieve entities

Sample request

curl -i -H "Authorization: F3C27EF4A0B216C72EC572E16C27C6DF137FC14ED97E2596C119938191AD8E94A978C02B53C0B382E0CC5674561C09A82024A685D146331ADB247B53129DD28EA302134286133710E6DDAD1A96C7EB0D" -H "Content-type: application/json" -X POST -d "@vid_postdata.json" https://my.veevanetwork.com/api/v21.0/entities/batch

Sample POST data

{
  "entities": [
    {
      "vid_key": "Network:Entity:932315773830225247"
    },
    {
      "vid_key": "Network:Entity:932910724243720799"
    },
    {
      "vid_key": "Network:Entity:932241620698597983"
    }
  ],
  "systemName": "change_request",
  "enrichedResults": "true",
  "resultLanguage": "en"
}

Sample response

{ 
   "responseStatus":"SUCCESS",
   "entities":[ 
      { 
         "entityId":"932315773830225247",
         "entityType":"HCP",
         "metaData":{ 

         },
         "entity":{ 
            "gender__v":"M",
            "gender__v_value__u":"Male",
            "specialty_1__v":"AC",
            "specialty_1__v_value__u":"Acute Care",
            "hcp_type__v":"P",
            "hcp_type__v_value__u":"Prescriber",
            "first_name__v":"James",
            "record_owner_type__v":"LOCAL",
            "record_owner_type__v_value__u":"Locally Managed",
            "grad_training__v":"N",
            "grad_training__v_value__u":"No/False",
            "record_delta_id__v":"932315774409474047",
            "last_name__v":"Smith",
            "record_owner_name__v":"Local",
            "fellow__v":"N",
            "fellow__v_value__u":"No/False",
            "kaiser__v":"N",
            "kaiser__v_value__u":"No/False",
            "formatted_name__v":"James Smith",
            "primary_country__v":"US",
            "primary_country__v_value__u":"United States",
            "created_date__v":"2018-04-27T17:36:28.000Z",
            "pdrp_optout__v":"N",
            "pdrp_optout__v_value__u":"No/False",
            "is_veeva_master__v":false,
            "hcp_status__v":"A",
            "hcp_status__v_value__u":"Active",
            "ama_do_not_contact__v":"N",
            "ama_do_not_contact__v_value__u":"No/False",
            "status_update_time__v":"2018-04-27T17:36:27.000Z",
            "entity_type__v":"HCP",
            "entity_type__v_value__u":"Health Care Professional",
            "modified_date__v":"2018-04-27T17:36:28.000Z",
            "record_state__v":"UNDER_REVIEW",
            "record_state__v_value__u":"Under Review",
            "record_version__v":0,
            "vid__v":"932315773830225247",
            "is_externally_mastered__v":false,
            "specialty_1_rank__v":1,
            "addresses__v":[ 
               { 
                  "dpv_confirmed_indicator__v":"X",
                  "dpv_confirmed_indicator__v_value__u":"The address was not submitted for DPV confirmation",
                  "postal_code_primary__v":"58501",
                  "address_line_1__v":"326 Harolds Dr",
                  "record_owner_type__v":"LOCAL",
                  "record_owner_type__v_value__u":"Locally Managed",
                  "premise__v":"326",
                  "record_delta_id__v":"932315774330634240",
                  "record_owner_name__v":"Local",
                  "thoroughfare_trailing_type__v":"Dr",
                  "locality__v":"Bismarck",
                  "delivery_address__v":"326 Harolds Dr",
                  "administrative_area_parsed__v":"ND",
                  "country__v":"US",
                  "country__v_value__u":"United States",
                  "created_date__v":"2018-04-27T17:36:28.000Z",
                  "premise_number__v":"326",
                  "is_veeva_master__v":false,
                  "ISO_3166_3__v":"USA",
                  "ISO_3166_3__v_value__u":"United States",
                  "ISO_3166_n__v":"840",
                  "ISO_3166_n__v_value__u":"United States",
                  "thoroughfare__v":"Harolds Dr",
                  "status_update_time__v":"2018-04-27T17:36:28.000Z",
                  "address_type__v":"P",
                  "address_type__v_value__u":"Professional",
                  "delivery_address_1__v":"326 Harolds Dr",
                  "sub_administrative_area__v":"Burleigh",
                  "entity_type__v":"HCP",
                  "entity_type__v_value__u":"Health Care Professional",
                  "address_verification_status__v":"P",
                  "address_verification_status__v_value__u":"Partially Verified",
                  "address_status__v":"A",
                  "address_status__v_value__u":"Active",
                  "modified_date__v":"2018-04-27T17:36:28.000Z",
                  "record_state__v":"UNDER_REVIEW",
                  "record_state__v_value__u":"Under Review",
                  "vid__v":"932315773850225248",
                  "entity_vid__v":"932315773830225247",
                  "postal_code__v":"58501",
                  "administrative_area__v":"US-ND",
                  "administrative_area__v_value__u":"North Dakota",
                  "formatted_address__v":"326 Harolds Dr Bismarck ND 58501",
                  "latitude__v":46.815034,
                  "address_ordinal__v":1,
                  "thoroughfare_name__v":"Harolds",
                  "longitude__v":-100.774784,
                  "custom_keys__v":[ 

                  ],
                  "entity_type__u":"ADDRESS",
                  "object_name__u":"ADDRESS"
               }
            ],
            "custom_keys__v":[ 
               { 
                  "custom_key_entity_id__v":"932315773830225247",
                  "custom_key_item_type__v":"DCRID__v",
                  "custom_key_value__v":"932315773398571455",
                  "modified_date__v":"2018-04-27T17:36:28.000Z",
                  "vid__v":"932315774299736671",
                  "custom_key_vid_key__v":"WORKFLOW__v:DCRID__v:932315773598571455",
                  "custom_key_source_type__v":"WORKFLOW__v",
                  "created_date__v":"2018-04-27T17:36:28.000Z",
                  "custom_key_entity_type__v":"HCP",
                  "custom_key_status__v":"A",
                  "custom_key_status__v_value__u":"Active",
                  "status_update_time__v":"2018-04-27T17:36:28.000Z",
                  "entity_type__v":"EXTERNALKEYS",
                  "entity_type__v_value__u":"EXTERNALKEYS",
                  "entity_type__u":"EXTERNALKEYS",
                  "object_name__u":"CUSTOMKEY"
               },
               { 
                  "custom_key_entity_id__v":"932315773830225247",
                  "custom_key_item_type__v":"HCP",
                  "custom_key_value__v":"932315773830225247",
                  "modified_date__v":"2018-04-27T17:36:28.000Z",
                  "vid__v":"932315774291741279",
                  "custom_key_vid_key__v":"CUSTOMER__v/3/change_request:HCP:932315773830225247",
                  "custom_key_source_type__v":"CUSTOMER__v/3/change_request",
                  "created_date__v":"2018-04-27T17:36:28.000Z",
                  "custom_key_entity_type__v":"HCP",
                  "custom_key_status__v":"A",
                  "custom_key_status__v_value__u":"Active",
                  "status_update_time__v":"2018-04-27T17:36:28.000Z",
                  "entity_type__v":"EXTERNALKEYS",
                  "entity_type__v_value__u":"EXTERNALKEYS",
                  "entity_type__u":"EXTERNALKEYS",
                  "object_name__u":"CUSTOMKEY"
               }
            ],
            "licenses__v":[ 
               { 
                  "primary_license__c":"U",
                  "primary_license__c_value__u":"Unknown/No response",
                  "address_vid__v":"932315773830225248",
                  "record_owner_type__v":"LOCAL",
                  "record_owner_type__v_value__u":"Locally Managed",
                  "effective_date__v":"2010-05-05",
                  "license_number__v":"1256987",
                  "status_update_time__v":"2018-04-27T17:36:28.000Z",
                  "record_delta_id__v":"932315774330634241",
                  "license_status__v":"A",
                  "license_status__v_value__u":"Active",
                  "entity_type__v":"HCP",
                  "entity_type__v_value__u":"Health Care Professional",
                  "record_owner_name__v":"Local",
                  "expiration_date__v":"2013-12-31",
                  "body__v":"ALMD",
                  "modified_date__v":"2018-04-27T17:36:28.000Z",
                  "record_state__v":"UNDER_REVIEW",
                  "record_state__v_value__u":"Under Review",
                  "license_status_condition__v":"0",
                  "license_status_condition__v_value__u":"No Known Conditions",
                  "license_subtype__v":"U",
                  "license_subtype__v_value__u":"Unlimited",
                  "vid__v":"932315773830225249",
                  "entity_vid__v":"932315773850225247",
                  "created_date__v":"2018-04-27T17:36:28.000Z",
                  "is_veeva_master__v":false,
                  "custom_keys__v":[ 

                  ],
                  "entity_type__u":"LICENSE",
                  "object_name__u":"LICENSE",
                  "address_vid__v_value__u":"326 Harolds Dr Bismarck ND 58501"
               }
            ],
            "parent_hcos__v":[ 

            ],
            "entity_type__u":"HCP",
            "object_name__u":"HCP"
         }
      },
      { 
         "entityId":"932910724243720799",
         "entityType":"HCP",
         "metaData":{ 

         },
         "entity":{ 
            "gender__v":"M",
            "gender__v_value__u":"Male",
            "specialty_1__v":"AC",
            "specialty_1__v_value__u":"Acute Care",
            "hcp_type__v":"P",
            "hcp_type__v_value__u":"Prescriber",
            "first_name__v":"Miranda",
            "record_owner_type__v":"LOCAL",
            "record_owner_type__v_value__u":"Locally Managed",
            "grad_training__v":"N",
            "grad_training__v_value__u":"No/False",
            "record_delta_id__v":"932910724917329920",
            "last_name__v":"Jane",
            "record_owner_name__v":"Local",
            "fellow__v":"N",
            "fellow__v_value__u":"No/False",
            "kaiser__v":"N",
            "kaiser__v_value__u":"No/False",
            "formatted_name__v":"Miranda Jane",
            "primary_country__v":"US",
            "primary_country__v_value__u":"United States",
            "created_date__v":"2018-08-10T19:20:09.000Z",
            "pdrp_optout__v":"N",
            "pdrp_optout__v_value__u":"No/False",
            "is_veeva_master__v":false,
            "hcp_status__v":"A",
            "hcp_status__v_value__u":"Active",
            "ama_do_not_contact__v":"N",
            "ama_do_not_contact__v_value__u":"No/False",
            "status_update_time__v":"2018-08-10T19:20:08.000Z",
            "entity_type__v":"HCP",
            "entity_type__v_value__u":"Health Care Professional",
            "modified_date__v":"2018-08-10T19:20:11.000Z",
            "record_state__v":"VALID",
            "record_state__v_value__u":"Valid",
            "record_version__v":1,
            "vid__v":"932910724243720799",
            "is_externally_mastered__v":false,
            "specialty_1_rank__v":1,
            "addresses__v":[ 
               { 
                  "postal_code_primary__v":"58501",
                  "address_line_1__v":"326 Harolds Drive",
                  "record_owner_type__v":"LOCAL",
                  "record_owner_type__v_value__u":"Locally Managed",
                  "premise__v":"326",
                  "record_delta_id__v":"932910724760764415",
                  "record_owner_name__v":"Local",
                  "thoroughfare_trailing_type__v":"DR",
                  "locality__v":"BISMARCK",
                  "delivery_address__v":"326 Harolds DR",
                  "country__v":"US",
                  "country__v_value__u":"United States",
                  "created_date__v":"2018-08-10T19:20:09.000Z",
                  "premise_number__v":"326",
                  "is_veeva_master__v":false,
                  "ISO_3166_3__v":"USA",
                  "ISO_3166_3__v_value__u":"United States",
                  "ISO_3166_n__v":"840",
                  "ISO_3166_n__v_value__u":"United States",
                  "thoroughfare__v":"Harolds DR",
                  "status_update_time__v":"2018-08-10T19:20:09.000Z",
                  "address_type__v":"P",
                  "address_type__v_value__u":"Professional",
                  "delivery_address_1__v":"326 Harolds DR",
                  "entity_type__v":"HCP",
                  "entity_type__v_value__u":"Health Care Professional",
                  "address_verification_status__v":"DS",
                  "address_verification_status__v_value__u":"Data Steward Approved",
                  "address_status__v":"A",
                  "address_status__v_value__u":"Active",
                  "modified_date__v":"2018-08-10T19:20:11.000Z",
                  "record_state__v":"VALID",
                  "record_state__v_value__u":"Valid",
                  "vid__v":"932910724244965983",
                  "entity_vid__v":"932910724243720799",
                  "postal_code__v":"58501",
                  "administrative_area__v":"US-ND",
                  "administrative_area__v_value__u":"North Dakota",
                  "formatted_address__v":"326 Harolds DR BISMARCK ND 58501",
                  "latitude__v":46.815034,
                  "address_ordinal__v":1,
                  "thoroughfare_name__v":"Harolds",
                  "longitude__v":-100.774784,
                  "custom_keys__v":[ 

                  ],
                  "entity_type__u":"ADDRESS",
                  "object_name__u":"ADDRESS"
               }
            ],
            "custom_keys__v":[ 
               { 
                  "custom_key_entity_id__v":"932910724243720799",
                  "custom_key_item_type__v":"DCRID__v",
                  "custom_key_value__v":"932910723585545759",
                  "modified_date__v":"2018-08-10T19:20:09.000Z",
                  "vid__v":"932910724587260511",
                  "custom_key_vid_key__v":"WORKFLOW__v:DCRID__v:932910723585545759",
                  "custom_key_source_type__v":"WORKFLOW__v",
                  "created_date__v":"2018-08-10T19:20:09.000Z",
                  "custom_key_entity_type__v":"HCP",
                  "custom_key_status__v":"A",
                  "custom_key_status__v_value__u":"Active",
                  "status_update_time__v":"2018-08-10T19:20:09.000Z",
                  "entity_type__v":"EXTERNALKEYS",
                  "entity_type__v_value__u":"EXTERNALKEYS",
                  "entity_type__u":"EXTERNALKEYS",
                  "object_name__u":"CUSTOMKEY"
               },
               { 
                  "custom_key_entity_id__v":"932910724243720799",
                  "custom_key_item_type__v":"HCP",
                  "custom_key_value__v":"932910724243720799",
                  "modified_date__v":"2018-08-10T19:20:09.000Z",
                  "vid__v":"932910724572908127",
                  "custom_key_vid_key__v":"CUSTOMER__v/3/change_request:HCP:932910724243720799",
                  "custom_key_source_type__v":"CUSTOMER__v/3/change_request",
                  "created_date__v":"2018-08-10T19:20:09.000Z",
                  "custom_key_entity_type__v":"HCP",
                  "custom_key_status__v":"A",
                  "custom_key_status__v_value__u":"Active",
                  "status_update_time__v":"2018-08-10T19:20:09.000Z",
                  "entity_type__v":"EXTERNALKEYS",
                  "entity_type__v_value__u":"EXTERNALKEYS",
                  "entity_type__u":"EXTERNALKEYS",
                  "object_name__u":"CUSTOMKEY"
               }
            ],
            "licenses__v":[ 
               { 
                  "primary_license__c":"U",
                  "primary_license__c_value__u":"Unknown/No response",
                  "address_vid__v":"932910724244965983",
                  "record_owner_type__v":"LOCAL",
                  "record_owner_type__v_value__u":"Locally Managed",
                  "effective_date__v":"2010-05-05",
                  "license_number__v":"1256987",
                  "status_update_time__v":"2018-08-10T19:20:09.000Z",
                  "record_delta_id__v":"932910724760764416",
                  "license_status__v":"A",
                  "license_status__v_value__u":"Active",
                  "entity_type__v":"HCP",
                  "entity_type__v_value__u":"Health Care Professional",
                  "record_owner_name__v":"Local",
                  "expiration_date__v":"2013-12-31",
                  "body__v":"ALMD",
                  "modified_date__v":"2018-08-10T19:20:11.000Z",
                  "record_state__v":"VALID",
                  "record_state__v_value__u":"Valid",
                  "license_status_condition__v":"0",
                  "license_status_condition__v_value__u":"No Known Conditions",
                  "license_subtype__v":"U",
                  "license_subtype__v_value__u":"Unlimited",
                  "vid__v":"932910724244965984",
                  "entity_vid__v":"932910724243720799",
                  "created_date__v":"2018-08-10T19:20:09.000Z",
                  "is_veeva_master__v":false,
                  "custom_keys__v":[ 

                  ],
                  "entity_type__u":"LICENSE",
                  "object_name__u":"LICENSE",
                  "address_vid__v_value__u":"326 Harolds DR BISMARCK ND 58501"
               }
            ],
            "parent_hcos__v":[ 

            ],
            "entity_type__u":"HCP",
            "object_name__u":"HCP"
         }
      },
      { 
         "entityId":"932241620698597983",
         "entityType":"HCP",
         "metaData":{ 

         },
         "entity":{ 
            "gender__v":"M",
            "gender__v_value__u":"Male",
            "specialty_1__v":"AC",
            "specialty_1__v_value__u":"Acute Care",
            "hcp_type__v":"P",
            "hcp_type__v_value__u":"Prescriber",
            "first_name__v":"Wilf",
            "record_owner_type__v":"LOCAL",
            "record_owner_type__v_value__u":"Locally Managed",
            "grad_training__v":"N",
            "grad_training__v_value__u":"No/False",
            "record_delta_id__v":"932241620768227327",
            "last_name__v":"Knoxford",
            "record_owner_name__v":"Local",
            "fellow__v":"N",
            "fellow__v_value__u":"No/False",
            "kaiser__v":"N",
            "kaiser__v_value__u":"No/False",
            "formatted_name__v":"Wilf Knoxford",
            "primary_country__v":"US",
            "primary_country__v_value__u":"United States",
            "created_date__v":"2018-04-14T15:18:14.000Z",
            "pdrp_optout__v":"N",
            "pdrp_optout__v_value__u":"No/False",
            "is_veeva_master__v":false,
            "hcp_status__v":"A",
            "hcp_status__v_value__u":"Active",
            "ama_do_not_contact__v":"N",
            "ama_do_not_contact__v_value__u":"No/False",
            "status_update_time__v":"2018-04-14T15:18:14.000Z",
            "entity_type__v":"HCP",
            "entity_type__v_value__u":"Health Care Professional",
            "modified_date__v":"2018-04-14T15:18:14.000Z",
            "record_state__v":"UNDER_REVIEW",
            "record_state__v_value__u":"Under Review",
            "record_version__v":0,
            "vid__v":"932241620698597983",
            "is_externally_mastered__v":false,
            "specialty_1_rank__v":1,
            "addresses__v":[ 
               { 
                  "dpv_confirmed_indicator__v":"X",
                  "dpv_confirmed_indicator__v_value__u":"The address was not submitted for DPV confirmation",
                  "postal_code_primary__v":"58501",
                  "address_line_1__v":"326 Harolds Dr",
                  "record_owner_type__v":"LOCAL",
                  "record_owner_type__v_value__u":"Locally Managed",
                  "premise__v":"326",
                  "record_delta_id__v":"932241620746207232",
                  "record_owner_name__v":"Local",
                  "thoroughfare_trailing_type__v":"Dr",
                  "locality__v":"Bismarck",
                  "delivery_address__v":"326 Harolds Dr",
                  "administrative_area_parsed__v":"ND",
                  "country__v":"US",
                  "country__v_value__u":"United States",
                  "created_date__v":"2018-04-14T15:18:14.000Z",
                  "premise_number__v":"326",
                  "is_veeva_master__v":false,
                  "ISO_3166_3__v":"USA",
                  "ISO_3166_3__v_value__u":"United States",
                  "ISO_3166_n__v":"840",
                  "ISO_3166_n__v_value__u":"United States",
                  "thoroughfare__v":"Harolds Dr",
                  "status_update_time__v":"2018-04-14T15:18:14.000Z",
                  "address_type__v":"P",
                  "address_type__v_value__u":"Professional",
                  "delivery_address_1__v":"326 Harolds Dr",
                  "sub_administrative_area__v":"Burleigh",
                  "entity_type__v":"HCP",
                  "entity_type__v_value__u":"Health Care Professional",
                  "address_verification_status__v":"P",
                  "address_verification_status__v_value__u":"Partially Verified",
                  "address_status__v":"A",
                  "address_status__v_value__u":"Active",
                  "modified_date__v":"2018-04-14T15:18:14.000Z",
                  "record_state__v":"UNDER_REVIEW",
                  "record_state__v_value__u":"Under Review",
                  "vid__v":"932241620698597984",
                  "entity_vid__v":"932241620698597983",
                  "postal_code__v":"58501",
                  "administrative_area__v":"US-ND",
                  "administrative_area__v_value__u":"North Dakota",
                  "formatted_address__v":"326 Harolds Dr Bismarck ND 58501",
                  "latitude__v":46.815034,
                  "address_ordinal__v":1,
                  "thoroughfare_name__v":"Harolds",
                  "longitude__v":-100.774784,
                  "custom_keys__v":[ 

                  ],
                  "entity_type__u":"ADDRESS",
                  "object_name__u":"ADDRESS"
               }
            ],
            "custom_keys__v":[ 
               { 
                  "custom_key_entity_id__v":"932241620698597983",
                  "custom_key_item_type__v":"HCP",
                  "custom_key_value__v":"932241620698597983",
                  "modified_date__v":"2018-04-14T15:18:14.000Z",
                  "vid__v":"932241620721404511",
                  "custom_key_vid_key__v":"CUSTOMER__v/3/change_request:HCP:932241620698597983",
                  "custom_key_source_type__v":"CUSTOMER__v/3/change_request",
                  "created_date__v":"2018-04-14T15:18:14.000Z",
                  "custom_key_entity_type__v":"HCP",
                  "custom_key_status__v":"A",
                  "custom_key_status__v_value__u":"Active",
                  "status_update_time__v":"2018-04-14T15:18:14.000Z",
                  "entity_type__v":"EXTERNALKEYS",
                  "entity_type__v_value__u":"EXTERNALKEYS",
                  "entity_type__u":"EXTERNALKEYS",
                  "object_name__u":"CUSTOMKEY"
               },
               { 
                  "custom_key_entity_id__v":"932241620698597983",
                  "custom_key_item_type__v":"DCRID__v",
                  "custom_key_value__v":"932241620548916767",
                  "modified_date__v":"2018-04-14T15:18:14.000Z",
                  "vid__v":"932241620725926495",
                  "custom_key_vid_key__v":"WORKFLOW__v:DCRID__v:932241620548916767",
                  "custom_key_source_type__v":"WORKFLOW__v",
                  "created_date__v":"2018-04-14T15:18:14.000Z",
                  "custom_key_entity_type__v":"HCP",
                  "custom_key_status__v":"A",
                  "custom_key_status__v_value__u":"Active",
                  "status_update_time__v":"2018-04-14T15:18:14.000Z",
                  "entity_type__v":"EXTERNALKEYS",
                  "entity_type__v_value__u":"EXTERNALKEYS",
                  "entity_type__u":"EXTERNALKEYS",
                  "object_name__u":"CUSTOMKEY"
               }
            ],
            "licenses__v":[ 
               { 
                  "primary_license__c":"U",
                  "primary_license__c_value__u":"Unknown/No response",
                  "address_vid__v":"932241620698597984",
                  "record_owner_type__v":"LOCAL",
                  "record_owner_type__v_value__u":"Locally Managed",
                  "effective_date__v":"2010-05-05",
                  "license_number__v":"1256987",
                  "status_update_time__v":"2018-04-14T15:18:14.000Z",
                  "record_delta_id__v":"932241620746207233",
                  "license_status__v":"A",
                  "license_status__v_value__u":"Active",
                  "entity_type__v":"HCP",
                  "entity_type__v_value__u":"Health Care Professional",
                  "record_owner_name__v":"Local",
                  "expiration_date__v":"2013-12-31",
                  "body__v":"ALMD",
                  "modified_date__v":"2018-04-14T15:18:14.000Z",
                  "record_state__v":"UNDER_REVIEW",
                  "record_state__v_value__u":"Under Review",
                  "license_status_condition__v":"0",
                  "license_status_condition__v_value__u":"No Known Conditions",
                  "license_subtype__v":"U",
                  "license_subtype__v_value__u":"Unlimited",
                  "vid__v":"932241620698597985",
                  "entity_vid__v":"932241620698597983",
                  "created_date__v":"2018-04-14T15:18:14.000Z",
                  "is_veeva_master__v":false,
                  "custom_keys__v":[ 

                  ],
                  "entity_type__u":"LICENSE",
                  "object_name__u":"LICENSE",
                  "address_vid__v_value__u":"326 Harolds Dr Bismarck ND 58501"
               }
            ],
            "parent_hcos__v":[ 

            ],
            "entity_type__u":"HCP",
            "object_name__u":"HCP"
         }
      }
   ]
}

This API enables you to obtain information about entities directly from Network through the API. Users are only allowed to retrieve (GET) information from Network.

All other operations (POST and DELETE) are restricted and can only be performed by submitting a change request using the Change Request APIs.

Endpoint URL

https://{DNS}/api/{version}/entities/batch

This API takes no parameters.

POST data
entities An array of fields and values for each entity.
  • vid_key - The external HCP or HCO vid_key supplied by the client.
systemName When provided, Network returns target alias values defined for reference codes for this system. Otherwise, Network returns default reference code values.
enrichedResults Specifies whether or not to display labels for reference type fields in the results.
resultLanguage Specifies the language to use if the enriched results option is enabled. Uses the IETF BCP 47 language standard.
Response
responseStatus The status of the response in Network.
errors An array of errors.
  • type - The error type.
  • message - A detailed message for the error type. This message is subject to change and is not contractual for error handling.
entities An array of fields and values for each entity.
  • entityType - The entity type.
  • metaData - Included for structure only; not applicable for this call.
  • entity - The fields and corresponding values for the entity.

Notes

Changelog

Version 19.0 added the enrichedResults and resultLanguage parameters.

Batch retrieve child entities

Sample request

curl -i -H "Authorization: F3C27EF4A0B216C72EC572E16C27C6DF137FC14ED97E2596C119938191AD8E94A978C02B53C0B382E0CC5674561C09A82024A685D146331ADB247B53129DD28EA302134286133710E6DDAD1A96C7EB0D" -H "Content-type: application/json" -X POST -d "@vid_postdata_license.json" https://my.veevanetwork.com/api/v21.0/children/batch

Sample POST data

{
  "entities": [
    {
      "vid_key": "Network:License:935315773850225249"
    },
    {
      "vid_key": "Network:License:932910724244965984"
    },
    {
      "vid_key": "Network:License:932241620698597985"
    }
  ],
  "systemName": "change_request",
  "enrichedResults": "true",
  "resultLanguage": "en"
}

Sample response

{ 
   "responseStatus":"PARTIAL_SUCCESS",
   "errors":[ 
      { 
         "type":"INVALID_DATA",
         "message":"No entity found with the given Id Network:License:935315773850225249"
      }
   ],
   "entities":[ 
      { 
         "entityId":"932241620698597985",
         "entityType":"LICENSE",
         "metaData":{ 

         },
         "entity":{ 
            "primary_license__c":"U",
            "primary_license__c_value__u":"Unknown/No response",
            "address_vid__v":"932241620698597984",
            "record_owner_type__v":"LOCAL",
            "record_owner_type__v_value__u":"Locally Managed",
            "effective_date__v":"2010-05-05",
            "license_number__v":"1256987",
            "status_update_time__v":"2018-04-14T15:18:14.000Z",
            "record_delta_id__v":"932241620746207233",
            "license_status__v":"A",
            "license_status__v_value__u":"Active",
            "entity_type__v":"HCP",
            "entity_type__v_value__u":"Health Care Professional",
            "record_owner_name__v":"Local",
            "expiration_date__v":"2013-12-31",
            "body__v":"ALMD",
            "modified_date__v":"2018-04-14T15:18:14.000Z",
            "record_state__v":"UNDER_REVIEW",
            "record_state__v_value__u":"Under Review",
            "license_status_condition__v":"0",
            "license_status_condition__v_value__u":"No Known Conditions",
            "license_subtype__v":"U",
            "license_subtype__v_value__u":"Unlimited",
            "vid__v":"932241620698597985",
            "entity_vid__v":"932241620698597983",
            "created_date__v":"2018-04-14T15:18:14.000Z",
            "is_veeva_master__v":false,
            "entity_type__u":"LICENSE",
            "object_name__u":"LICENSE",
            "address_vid__v_value__u":"326 Harolds Dr Bismarck ND 58501"
         }
      },
      { 
         "entityId":"932910724244965984",
         "entityType":"LICENSE",
         "metaData":{ 

         },
         "entity":{ 
            "primary_license__c":"U",
            "primary_license__c_value__u":"Unknown/No response",
            "address_vid__v":"932910724244965983",
            "record_owner_type__v":"LOCAL",
            "record_owner_type__v_value__u":"Locally Managed",
            "effective_date__v":"2010-05-05",
            "license_number__v":"1256987",
            "status_update_time__v":"2018-08-10T19:20:09.000Z",
            "record_delta_id__v":"932910724760764416",
            "license_status__v":"A",
            "license_status__v_value__u":"Active",
            "entity_type__v":"HCP",
            "entity_type__v_value__u":"Health Care Professional",
            "record_owner_name__v":"Local",
            "expiration_date__v":"2013-12-31",
            "body__v":"ALMD",
            "modified_date__v":"2018-08-10T19:20:11.000Z",
            "record_state__v":"VALID",
            "record_state__v_value__u":"Valid",
            "license_status_condition__v":"0",
            "license_status_condition__v_value__u":"No Known Conditions",
            "license_subtype__v":"U",
            "license_subtype__v_value__u":"Unlimited",
            "vid__v":"932910724244965984",
            "entity_vid__v":"932910724243720799",
            "created_date__v":"2018-08-10T19:20:09.000Z",
            "is_veeva_master__v":false,
            "entity_type__u":"LICENSE",
            "object_name__u":"LICENSE",
            "address_vid__v_value__u":"326 Harolds DR BISMARCK ND 58501"
         }
      }
   ]
}

This API enables you to obtain information on child entities without identifying the specific entity type. Users are only allow the retrieve (GET) information from Network.

All other operations (POST and DELETE) are restricted and can only be performed by submitting a change request using the Change Request APIs.

Endpoint URL

https://{DNS}/api/{version}/children/batch

This API takes no parameters.

POST data
entities An array of objects:
  • vid_key - The external child entity; for example, license or address vid_key supplied by the client.
systemName When provided, Network returns target alias values defined for reference codes for this system. Otherwise, Network returns default reference code values.
enrichedResults Specifies whether or not to display labels for reference type fields in the results.
resultLanguage Specifies the language to use if the enriched results option is enabled. Uses the IETF BCP 47 language standard.
Response
responseStatus The status of the response in Network.
errors An array of errors.
  • type - The error type.
  • message - A detailed message for the error type. This message is subject to change and is not contractual for error handling.
entities An array of fields and values for each entity.
  • entityId - The Network ID of the entity.
  • entityType - The entity type.
  • metaData - Included for structure only; not applicable for this call.
  • entity - The fields and corresponding values for the entity.

Notes

Changelog

Version 19.0 added the enrichedResults and resultLanguage parameters.

Health care organization (HCO)

The health care organization API enable you to retrieve HCO information and associate custom keys with or disassociate them from other entities.

Retrieve HCO

Sample request

curl -X GET -H "Authorization: 57696C6C205261...6368204A6F7368" https://my.veevanetwork.com/api/v21.0/hcos/Network:Entity:932241745093790303

Sample response

{
   "responseStatus" : "SUCCESS",
   "entities" : [
      {
         "entityId" : "932241745093790303",
         "entityType" : "HCO",
         "metaData" : {},
         "entity" : {
            "hco_status__v" : "A",
            "primary_country__v" : "US",
            "training_facility__v" : "N",
            "parent_hcos__v" : [],
            "is_veeva_master__v" : false,
            "created_date__v" : "2018-04-14T15:49:51.000Z",
            "record_version__v" : 1,
            "status_update_time__v" : "2018-04-14T15:49:51.000Z",
            "record_state__v" : "VALID",
            "record_owner_name__v" : "Local",
            "xray_services__v" : "N",
            "addresses__v" : [
               {
                  "premise__v" : "15",
                  "address_ordinal__v" : 1,
                  "record_owner_type__v" : "LOCAL",
                  "custom_keys__v" : [],
                  "administrative_area_parsed__v" : "NY",
                  "delivery_address_1__v" : "15 Central Park W",
                  "record_owner_name__v" : "Local",
                  "ISO_3166_3__v" : "USA",
                  "locality__v" : "New York",
                  "longitude__v" : -73.98088,
                  "administrative_area__v" : "US-NY",
                  "premise_number__v" : "15",
                  "is_veeva_master__v" : false,
                  "ISO_3166_n__v" : "840",
                  "address_verification_status__v" : "P",
                  "thoroughfare_trailing_type__v" : "Park",
                  "address_line_1__v" : "15 Central Park W",
                  "thoroughfare_post_direction__v" : "W",
                  "modified_date__v" : "2018-04-14T15:50:18.000Z",
                  "postal_code__v" : "10023",
                  "vid__v" : "932241745093790304",
                  "record_delta_id__v" : "932241746852020224",
                  "entity_vid__v" : "932241745093790303",
                  "entity_type__v" : "HCO",
                  "thoroughfare__v" : "Central Park W",
                  "thoroughfare_name__v" : "Central",
                  "country__v" : "US",
                  "address_status__v" : "A",
                  "dpv_confirmed_indicator__v" : "X",
                  "latitude__v" : 40.76973,
                  "created_date__v" : "2018-04-14T15:49:51.000Z",
                  "address_type__v" : "B",
                  "formatted_address__v" : "15 Central Park W New York NY 10023",
                  "record_state__v" : "VALID",
                  "postal_code_primary__v" : "10023",
                  "delivery_address__v" : "15 Central Park W",
                  "sub_administrative_area__v" : "New York",
                  "status_update_time__v" : "2018-04-14T15:49:51.000Z"
               }
            ],
            "va_dod_affiliated__v" : "U",
            "custom_keys__v" : [
               {
                  "custom_key_status__v" : "A",
                  "custom_key_entity_id__v" : "932241745093790303",
                  "custom_key_entity_type__v" : "HCO",
                  "custom_key_value__v" : "932241745093790303",
                  "custom_key_source_type__v" : "CUSTOMER__v/3/change_request",
                  "modified_date__v" : "2018-04-14T15:49:51.000Z",
                  "vid__v" : "932241745111681631",
                  "custom_key_item_type__v" : "HCO",
                  "status_update_time__v" : "2018-04-14T15:49:51.000Z",
                  "created_date__v" : "2018-04-14T15:49:51.000Z",
                  "custom_key_vid_key__v" : "CUSTOMER__v/3/change_request:HCO:932241745093790303"
               },
               {
                  "custom_key_entity_id__v" : "932241745093790303",
                  "custom_key_entity_type__v" : "HCO",
                  "custom_key_status__v" : "A",
                  "custom_key_source_type__v" : "WORKFLOW__v",
                  "custom_key_value__v" : "932241745037891103",
                  "modified_date__v" : "2018-04-14T15:49:51.000Z",
                  "vid__v" : "932241745112009311",
                  "custom_key_item_type__v" : "DCRID__v",
                  "custom_key_vid_key__v" : "WORKFLOW__v:DCRID__v:932241745037891103",
                  "created_date__v" : "2018-04-14T15:49:51.000Z",
                  "status_update_time__v" : "2018-04-14T15:49:51.000Z"
               }
            ],
            "vid__v" : "932241745093790303",
            "hco_type__v" : "4:15",
            "modified_date__v" : "2018-04-14T15:50:18.000Z",
            "record_delta_id__v" : "932241746865717247",
            "corporate_name__v" : "Mac Healthcare",
            "accept_medicare__v" : "N",
            "kaiser__v" : "N",
            "major_class_of_trade__v" : "4",
            "licenses__v" : [],
            "accept_medicaid__v" : "N",
            "is_externally_mastered__v" : false,
            "ama_do_not_contact__v" : "N",
            "record_owner_type__v" : "LOCAL",
            "lab_services__v" : "N"
         }
      }
   ]
}

This API enables you to retrieve information about an HCO. Information you can retrieve for an HCO includes the HCO, address, license, and parent HCO information (including their custom keys) for the HCO vid_key you provide.

Note: This API downloads the record for the specified entity from Veeva OpenData to your customer instance.

Endpoint URL

https://{DNS}/api/{version}/hcos/{vid_key}

Optional parameters
systemName Retrieve information for the specified system. If not specified, all information is returned.
enrichedResults Specifies whether or not to display labels for reference type fields in the results.
resultLanguage Specifies the language to use if the enriched results option is enabled. Uses the IETF BCP 47 language standard.
Response
responseStatus The status of the response from Network.
entities An array of attribute information objects:
  • entityId - the Network ID of the entity.
  • entityType - the entity type.
  • metaData - not applicable for this API, included for structure only.
  • entity - the entity that contains all of the attributes.

Notes

Changelog

Version 19.0 added the enrichedResults and resultLanguage parameters.

Associate custom key to HCO

Sample request

curl -X POST -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/hcos/Network:Entity:932241745093790303/custom_keys/?custom_key_source_type=HCO&custom_key_item_type=account&custom_key_value=12345'

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new HCOs are downloaded from Network without going through the full change request process. This API associates the external identifier you submit to the HCO vid_key you provide.

Note: This API requires system administrator or API-only permissions.

Endpoint URL

https://{DNS}/api/{version}/hcos/{vid_key}/custom_keys

Parameters
custom_key_source_type The source of the new key.
custom_key_item_type The item type for the new key.
custom_key_value The value for the new key.
system_name The name of the system for the new key.
Response
responseStatus The status of the response from Network.

Notes

responseStatus returns a failure if any standard errors occur or:

Changelog

Version 3.0 added the system_name parameter.

Associate custom key to HCO address

Sample request

curl -X POST -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/hcos/Network:Entity:932241745093790303/addresses/Network:Address:932241745093790304/custom_keys?custom_key_source_type=HCO&custom_key_item_type=account&custom_key_value=54321'

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new HCO addresses are downloaded from Network without going through the full change request process. This API associates the external identifier you submit to the HCO address_key you provide.

Note: This API requires system administrator or API-only permissions.

Endpoint URL

https://{DNS}/api/{version}/hcos/{vid_key}/addresses/{address_key}/custom_keys

Parameters
custom_key_source_type The source of the new key.
custom_key_item_type The item type for the new key.
custom_key_value The value for the new key.
system_name The name of the system for the new key.
Response
responseStatus The status of the response from Network.

Notes

responseStatus returns a failure if any standard errors occur or:

Changelog

Version 3.0 added the system_name parameter.

Associate custom key to HCO license

Sample request

curl -X POST -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/hcos/Network:Entity:932241745093790303/licenses/Network:License:937863645093876993/custom_keys?custom_key_source_type=HCO&custom_key_item_type=account&custom_key_value=54321'

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new HCO licenses are downloaded from Network without going through the full change request process. This API associates the external identifier you submit to the HCO license_key you provide.

Note: This API requires system administrator or API-only permissions.

Endpoint URL

https://{DNS}/api/{version}/hcos/{vid_key}/licenses/{license_key}/custom_keys

Parameters
custom_key_source_type The source of the new key.
custom_key_item_type The item type for the new key.
custom_key_value The value for the new key.
system_name The name of the system for the new key.
Response
responseStatus The status of the response from Network.

Notes

responseStatus returns a failure if any standard errors occur or:

Changelog

Version 3.0 added the system_name parameter.

Associate custom key to parent HCO

Sample request

curl -X POST -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/hcos/Network:Entity:932241745093790303/parent_hcos/Network:ParentHCO:987394745093668309/custom_keys?custom_key_source_type=HCO&custom_key_item_type=child&custom_key_value=54321'

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new HCO parent HCOs are downloaded from Network without going through the full change request process. This API associates the external identifier you submit to the HCO parenthco_key you provide.

Note: This API requires system administrator or API-only permissions.

Endpoint URL

https://{DNS}/api/{version}/hcos/{vid_key}/parent_hcos/{parenthco_key}/custom_keys

Parameters
custom_key_source_type The source of the new key.
custom_key_item_type The item type for the new key.
custom_key_value The value for the new key.
system_name The name of the system for the new key.
Response
responseStatus The status of the response from Network.

Notes

responseStatus returns a failure if any standard errors occur or:

Changelog

Version 3.0 added the system_name parameter.

Health care professional (HCP)

The health care professional API enable you to retrieve HCP information and associate custom keys with or disassociate them from other entities.

Retrieve HCP

Sample request

curl -X GET -H "Authorization: 57696C6C205261...6368204A6F7368" https://my.veevanetwork.com/api/v21.0/hcps/Network:Entity:932671707694238303

Sample response

{
   "entities" : [
      {
         "metaData" : {},
         "entity" : {
            "specialty_1__v" : "AC",
            "is_externally_mastered__v" : false,
            "vid__v" : "932671707694238303",
            "licenses__v" : [
               {
                  "record_state__v" : "VALID",
                  "modified_date__v" : "2018-06-29T14:15:02.000Z",
                  "address_vid__v" : "932671707694238304",
                  "is_veeva_master__v" : false,
                  "license_status_condition__v" : "0",
                  "license_subtype__v" : "U",
                  "record_owner_name__v" : "Local",
                  "effective_date__v" : "2010-05-05",
                  "primary_license__c" : "U",
                  "license_number__v" : "1256987",
                  "status_update_time__v" : "2018-06-29T14:15:00.000Z",
                  "record_owner_type__v" : "LOCAL",
                  "body__v" : "ALMD",
                  "vid__v" : "932671707694238305",
                  "entity_type__v" : "HCP",
                  "entity_vid__v" : "932671707694238303",
                  "expiration_date__v" : "2013-12-31",
                  "license_status__v" : "A",
                  "record_delta_id__v" : "932671707821604865",
                  "created_date__v" : "2018-06-29T14:15:00.000Z",
                  "custom_keys__v" : []
               }
            ],
            "record_version__v" : 1,
            "fellow__v" : "N",
            "hcp_status__v" : "A",
            "record_owner_type__v" : "LOCAL",
            "addresses__v" : [
               {
                  "premise_number__v" : "326",
                  "thoroughfare_trailing_type__v" : "DR",
                  "thoroughfare__v" : "Harolds DR",
                  "delivery_address_1__v" : "326 Harolds DR",
                  "premise__v" : "326",
                  "address_status__v" : "A",
                  "record_owner_type__v" : "LOCAL",
                  "locality__v" : "BISMARCK",
                  "longitude__v" : -100.774784,
                  "is_veeva_master__v" : false,
                  "delivery_address__v" : "326 Harolds DR",
                  "address_line_1__v" : "326 Harolds Drive",
                  "modified_date__v" : "2018-06-29T14:15:02.000Z",
                  "ISO_3166_3__v" : "USA",
                  "address_type__v" : "P",
                  "custom_keys__v" : [],
                  "created_date__v" : "2018-06-29T14:15:00.000Z",
                  "latitude__v" : 46.815034,
                  "address_verification_status__v" : "DS",
                  "record_delta_id__v" : "932671707821604864",
                  "thoroughfare_name__v" : "Harolds",
                  "formatted_address__v" : "326 Harolds DR BISMARCK ND 58501",
                  "entity_type__v" : "HCP",
                  "entity_vid__v" : "932671707694238303",
                  "ISO_3166_n__v" : "840",
                  "vid__v" : "932671707694238304",
                  "postal_code_primary__v" : "58501",
                  "country__v" : "US",
                  "postal_code__v" : "58501",
                  "status_update_time__v" : "2018-06-29T14:15:00.000Z",
                  "administrative_area__v" : "US-ND",
                  "record_owner_name__v" : "Local",
                  "address_ordinal__v" : 1,
                  "record_state__v" : "VALID"
               }
            ],
            "status_update_time__v" : "2018-06-29T14:15:00.000Z",
            "is_veeva_master__v" : false,
            "email_1__v" : "andrew.mcelroy@hotmail.com",
            "last_name__v" : "PbLuobGIefdQCNtvQ8ZsViU3t",
            "record_owner_name__v" : "Local",
            "pdrp_optout__v" : "N",
            "modified_date__v" : "2018-06-29T14:15:02.000Z",
            "first_name__v" : "cd1mhSAt7cUS6kg8NcK5oz6nF",
            "record_state__v" : "VALID",
            "kaiser__v" : "N",
            "specialty_1_rank__v" : 1,
            "custom_keys__v" : [
               {
                  "custom_key_entity_id__v" : "932671707694238303",
                  "custom_key_status__v" : "A",
                  "custom_key_entity_type__v" : "HCP",
                  "modified_date__v" : "2018-06-29T14:15:00.000Z",
                  "custom_key_value__v" : "932671707570838463",
                  "custom_key_vid_key__v" : "WORKFLOW__v:DCRID__v:932671707570838463",
                  "vid__v" : "932671707718093407",
                  "created_date__v" : "2018-06-29T14:15:00.000Z",
                  "custom_key_item_type__v" : "DCRID__v",
                  "custom_key_source_type__v" : "WORKFLOW__v",
                  "status_update_time__v" : "2018-06-29T14:15:00.000Z"
               },
               {
                  "custom_key_source_type__v" : "CUSTOMER__v/3/change_request",
                  "status_update_time__v" : "2018-06-29T14:15:00.000Z",
                  "custom_key_vid_key__v" : "CUSTOMER__v/3/change_request:HCP:932671707694238303",
                  "vid__v" : "932671707717372511",
                  "created_date__v" : "2018-06-29T14:15:00.000Z",
                  "custom_key_item_type__v" : "HCP",
                  "custom_key_entity_type__v" : "HCP",
                  "modified_date__v" : "2018-06-29T14:15:00.000Z",
                  "custom_key_value__v" : "932671707694238303",
                  "custom_key_entity_id__v" : "932671707694238303",
                  "custom_key_status__v" : "A"
               }
            ],
            "created_date__v" : "2018-06-29T14:15:00.000Z",
            "NewAlt__c" : "KP4J39SQJZC",
            "record_delta_id__v" : "932671707842248703",
            "formatted_name__v" : "John Smith",
            "gender__v" : "M",
            "grad_training__v" : "N",
            "parent_hcos__v" : [],
            "hcp_type__v" : "P",
            "primary_country__v" : "US",
            "ama_do_not_contact__v" : "N"
         },
         "entityType" : "HCP",
         "entityId" : "932671707694238303"
      }
   ],
   "responseStatus" : "SUCCESS"
}

This API enables you to retrieve information about an HCP. Information you can retrieve for an HCP includes the HCP, address, license, and parent HCO information (including their custom keys) for the HCP vid_key you provide.

Note: This API downloads the record for the specified entity from Veeva OpenData to your customer instance.

Endpoint URL

https://{DNS}/api/{version}/hcps/{vid_key}

Optional parameters
systemName Retrieve information for the specified system. If not specified, all information is returned.
enrichedResults Specifies whether or not to display labels for reference type fields in the results.
resultLanguage Specifies the language to use if the enriched results option is enabled. Uses the IETF BCP 47 language standard.
Response
responseStatus The status of the response from Network.
entities An array of attribute information objects:
  • entityId - the Network ID of the entity.
  • entityType - the entity type.
  • metaData - not applicable for this API, included for structure only.
  • entity - the entity that contains all of the attributes.

Notes

Changelog

Version 19.0 added the enrichedResults and resultLanguage parameters.

Associate custom key to HCP

Sample request

curl -X POST -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/hcps/Network:Entity:932671707694238303/custom_keys/?custom_key_source_type=HCP&custom_key_item_type=account&custom_key_value=12345'

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new HCPs are downloaded from Network without going through the full change request process. This API associates the external identifier you submit to the HCP vid_key you provide.

Note: This API requires system administrator or API-only permissions.

Endpoint URL

https://{DNS}/api/{version}/hcps/{vid_key}/custom_keys

Parameters
custom_key_source_type The source of the new key.
custom_key_item_type The item type for the new key.
custom_key_value The value for the new key.
system_name The name of the system for the new key.
Response
responseStatus The status of the response from Network.

Notes

responseStatus returns a failure if any standard errors occur or:

Changelog

Version 3.0 added the system_name parameter.

Associate custom key to HCP address

Sample request

curl -X POST -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/hcps/Network:Entity:932671707694238303/addresses/Network:Address:939836675093779544/custom_keys?custom_key_source_type=HCP&custom_key_item_type=account&custom_key_value=54321'

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new HCP addresses are downloaded from Network without going through the full change request process. This API associates the external identifier you submit to the HCP address_key you provide.

Note: This API requires system administrator or API-only permissions.

Endpoint URL

https://{DNS}/api/{version}/hcps/{vid_key}/addresses/{address_key}/custom_keys

Parameters
custom_key_source_type The source of the new key.
custom_key_item_type The item type for the new key.
custom_key_value The value for the new key.
system_name The name of the system for the new key.
Response
responseStatus The status of the response from Network.

Notes

responseStatus returns a failure if any standard errors occur or:

Changelog

Version 3.0 added the system_name parameter.

Associate custom key to HCP license

Sample request

curl -X POST -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/hcps/Network:Entity:932671707694238303/licenses/Network:License:999856675099568633/custom_keys?custom_key_source_type=HCP&custom_key_item_type=account&custom_key_value=54321'

Sample response

{
   "responseStatus": "SUCCESS"
}

This API enables you to submit external key identifiers when new HCP licenses are downloaded from Network without going through the full change request process. This API associates the external identifier you submit to the HCP license_key you provide.

Note: This API requires system administrator or API-only permissions.

Endpoint URL

https://{DNS}/api/{version}/hcps/{vid_key}/licenses/{license_key}/custom_keys

Parameters
custom_key_source_type The source of the new key.
custom_key_item_type The item type for the new key.
custom_key_value The value for the new key.
system_name The name of the system for the new key.
Response
responseStatus The status of the response from Network.

Notes

responseStatus returns a failure if any standard errors occur or:

Changelog

Version 3.0 added the system_name parameter.

Associate custom key to parent HCO

Sample request

curl -X POST -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/hcps/Network:Entity:932671707694238303/parent_hcos/Network:ParentHCO:987394745093668309/custom_keys?custom_key_source_type=HCP&custom_key_item_type=child&custom_key_value=54321'

Sample response

{
   "responseStatus": "SUCCESS"
}

The Associate custom key to HCP parent HCO API enables you to submit external key identifiers when new HCP parent HCOs are downloaded from Network without going through the full change request process. This API associates the external identifier you submit to the HCP parenthco_key you provide.

Note: This API requires system administrator or API-only permissions.

Endpoint URL

https://{DNS}/api/{version}/hcps/{vid_key}/parent_hcos/{parenthco_key}/custom_keys

Parameters
custom_key_source_type The source of the new key.
custom_key_item_type The item type for the new key.
custom_key_value The value for the new key.
system_name The name of the system for the new key.
Response
responseStatus The status of the response from Network.

Notes

responseStatus returns a failure if any standard errors occur or:

Changelog

Version 3.0 added the system_name parameter.

Metadata

Metadata enables you to retrieve summary and detailed information about fields, field groups. object types, and reference data. You can also retrieve summary information about each available Network API version.

Retrieve available API versions

Sample request

curl -X GET -H "Authorization: 57696C6C205261...6368204C6F7368" https://my.veevanetwork.com/api

Sample response

{
   "values": {
      "v1.0": "https://my.network.com/api/v1.0",
      "v2.0": "https://my.network.com/api/v2.0",
      "v3.0": "https://my.network.com/api/v3.0",
      "v4.0": "https://my.network.com/api/v4.0",
      "v5.0": "https://my.network.com/api/v5.0",
      "v6.0": "https://my.network.com/api/v6.0",
      "v7.0": "https://my.network.com/api/v7.0",
      "v8.0": "https://my.network.com/api/v8.0",
      "v9.0": "https://my.network.com/api/v9.0",
      "v10.0": "https://my.network.com/api/v10.0",
      "v11.0": "https://my.network.com/api/v11.0",
      "v12.0": "https://my.network.com/api/v12.0",
      "v13.0": "https://my.network.com/api/v13.0",
      "v14.0": "https://my.network.com/api/v14.0",
      "v15.0": "https://my.network.com/api/v15.0",
      "v16.0": "https://my.network.com/api/v16.0",
      "v17.0": "https://my.network.com/api/v17.0",
      "v18.0": "https://my.network.com/api/v18.0",
      "v19.0": "https://my.network.com/api/v19.0"
      "v20.0": "https://my.network.com/api/v20.0"
      "v21.0": "https://my.network.com/api/v21.0"
   },
    "responseStatus": "SUCCESS"
}

This API enables you to retrieve summary information about each API version available in Network.

Endpoint URL

https://{DNS}/api

This API takes no parameters.

Response
responseStatus The status of the response from Network.
values An array of values containing each available version and the version-specific API URL information.

Retrieve object types metadata

Sample request

curl -X GET -H "Authorization: 57696C6C205261...6368204C6F7368" https://my.veevanetwork.com/api/v21.0/metadata/objectTypes

Sample response

{
   "responseStatus" : "SUCCESS",
   "objectTypes" : [
      {
         "description" : "Health Care Professional",
         "type" : "object",
         "status" : "ACTIVE",
         "customer_defined" : false,
         "name" : "HCP"
      },
      {
         "description" : "Health Care Organization",
         "type" : "object",
         "name" : "HCO",
         "customer_defined" : false,
         "status" : "ACTIVE"
      },
      {
         "description" : "Address",
         "type" : "sub-object",
         "customer_defined" : false,
         "status" : "ACTIVE",
         "name" : "ADDRESS"
      },
      {
         "name" : "LICENSE",
         "status" : "ACTIVE",
         "customer_defined" : false,
         "type" : "sub-object",
         "description" : "License"
      },
      {
         "type" : "relationship",
         "description" : "Parent HCO",
         "name" : "PARENTHCO",
         "customer_defined" : false,
         "status" : "ACTIVE"
      },
      {
         "type" : "sub-object",
         "description" : "Custom Key",
         "customer_defined" : false,
         "status" : "ACTIVE",
         "name" : "CUSTOMKEY"
      },
      {
         "type": "object",
         "description": "Employee",
         "customer_defined": true,
         "status": "ACTIVE",
         "name": "EMPLOYEE__C"
      }
   ]
}

This API enables you to retrieve the list of object types available in Network.

Endpoint URL

https://{DNS}/api/{version}/metadata/objectTypes

Optional parameters
owner filter objects by customer- or Veeva-owned
Response
responseStatus The status of the response from Network.
objectTypes An array of attribute information objects:
  • name - the entity name (HCP, HCO, ADDRESS, LICENSE, PARENTHCO, CUSTOMKEY)
  • description - Localized text description of the entity
  • status - returns all types regardless of the status
  • customerDefined - True for custom objects, otherwise False
  • type - *object*, *sub-object*, or *relationship*

Changelog

Version 13.0 includes status in the response and returns all types regardless of its value.

Retrieve fields metadata

Sample request: Retrieve license object types

curl -X GET -H "Authorization: 57696C6C205261...6368204C6F7368" https://my.veevanetwork.com/api/v21.0/metadata/fields?objectTypes=license

Sample response: License object types

{
   "attributes" : [
      "address_vid__v",
      "address_vid_key",
      "anticipated_expiry_date__v",
      "best_state_license__v",
      "body__v",
      "created_date__v",
      "custom_keys__v",
      "dea_business_activity_code__v",
      "dea_payment_indicator__v",
      "drug_schedule__v",
      "effective_date__v",
      "entity_type__v",
      "entity_vid__v",
      "expiration_date__v",
      "grace_period__v",
      "initial_board_license_date__v",
      "is_externally_mastered__v",
      "is_proprietary__v",
      "is_veeva_master__v",
      "license_admin_area__v",
      "license_certification__v",
      "license_degree__v",
      "license_eligibility__v",
      "license_number__v",
      "license_status__v",
      "license_status_condition__v",
      "license_subtype__v",
      "licensing_body__v",
      "modified_date__v",
      "record_delta_id__v",
      "record_merged_vid__v",
      "record_owner_name__v",
      "record_owner_type__v",
      "record_state__v",
      "rxa_eligible__v",
      "source_address__v",
      "status_update_time__v",
      "type__v",
      "type_value__v",
      "vid__v"
   ],
   "responseStatus" : "SUCCESS"
}

Sample request: Retrieve license objects with full details

curl -X GET -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/metadata/fields?objectTypes=license&details=full'

Sample request:
Retrieve full details for license objects for GB and US

curl -X GET -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/metadata/fields?objectTypes=LICENSE&details=full&countries=GB,US'

Sample Response:
License objects with full details for US and GB

{
   "attributes" : [
      {
         "fieldGroup" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true,
         "defaultValue" : null,
         "expressionFlags" : 0,
         "sinceVersion" : "1.0.0",
         "labels" : {
            "zh" : "地址",
            "tr" : "Adres",
            "en" : "Address",
            "de" : "Anschrift",
            "pt" : "Endereço",
            "es" : "ID de la dirección",
            "pt-BR" : "Endereço",
            "zh_HK" : "地址",
            "nl" : "Adres",
            "fr" : "Adresse",
            "it" : "Indirizzo",
            "ja" : "住所"
         },
         "countries" : {
            "GB" : {
               "required" : false,
               "readOnly" : false,
               "allowedObjectTypes" : [],
               "available" : false,
               "defaultValue" : null,
               "expressionFlags" : 0,
               "country" : "GB",
               "expression" : null
            },
            "US" : {
               "expression" : null,
               "country" : "US",
               "expressionFlags" : 0,
               "available" : true,
               "defaultValue" : null,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "required" : false,
               "readOnly" : true
            }
         },
         "customerOwned" : false,
         "expression" : null,
         "type" : {
            "dataType" : "VEEVAID",
            "discriminator" : null
         },
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldId" : "address_vid__v",
         "required" : false,
         "fieldSet" : null,
         "readOnly" : false,
         "description" : "Unique Network ID number for this address",
         "ownerOnlyEdit" : false,
         "maximumLength" : 18,
         "status" : "ACTIVE"
      },
      {
         "status" : "ACTIVE",
         "maximumLength" : null,
         "ownerOnlyEdit" : false,
         "description" : "API parameter used to denote license addresses, not actually saved",
         "readOnly" : true,
         "fieldSet" : null,
         "required" : false,
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            }
         },
         "fieldId" : "address_vid_key",
         "type" : {
            "dataType" : "STRING",
            "discriminator" : null
         },
         "expression" : null,
         "countries" : {
            "US" : {
               "expressionFlags" : 0,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "available" : true,
               "defaultValue" : null,
               "readOnly" : true,
               "required" : false,
               "expression" : null,
               "country" : "US"
            },
            "GB" : {
               "expression" : null,
               "country" : "GB",
               "allowedObjectTypes" : [],
               "defaultValue" : null,
               "available" : false,
               "expressionFlags" : 0,
               "readOnly" : true,
               "required" : false
            }
         },
         "customerOwned" : false,
         "expressionFlags" : 0,
         "sinceVersion" : "1.0.0",
         "labels" : {},
         "defaultValue" : null,
         "dataPrivacyFlag" : "NONE",
         "blankAllowed" : true,
         "fieldGroup" : null
      },
      {
         "description" : "Anticipated expiry date.",
         "fieldSet" : null,
         "readOnly" : false,
         "required" : false,
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldId" : "anticipated_expiry_date__v",
         "status" : "ACTIVE",
         "maximumLength" : 25,
         "ownerOnlyEdit" : false,
         "expressionFlags" : 0,
         "sinceVersion" : "1.0.0",
         "labels" : {
            "nl" : "Verwachte vervaldatum",
            "fr" : "Date d'expiration prévue",
            "it" : "Data di scadenza anticipata",
            "ja" : "予定有効期限",
            "zh" : "预计到期日",
            "en" : "Anticipated Expiry Date",
            "tr" : "Beklenen Bitiş Tarihi",
            "de" : "Voraussichtliches Ablaufdatum",
            "pt" : "Data de expiração antecipada",
            "pt-BR" : "Data de vencimento antecipada",
            "es" : "Fecha de caducidad anticipada"
         },
         "defaultValue" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true,
         "fieldGroup" : null,
         "type" : {
            "dataType" : "DATE",
            "discriminator" : null
         },
         "expression" : null,
         "countries" : {
            "GB" : {
               "required" : false,
               "readOnly" : false,
               "expressionFlags" : 0,
               "defaultValue" : null,
               "available" : false,
               "allowedObjectTypes" : [],
               "country" : "GB",
               "expression" : null
            },
            "US" : {
               "country" : "US",
               "expression" : null,
               "readOnly" : true,
               "required" : false,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "available" : true,
               "defaultValue" : null,
               "expressionFlags" : 0
            }
         },
         "customerOwned" : false
      },
      {
         "status" : "ACTIVE",
         "ownerOnlyEdit" : false,
         "maximumLength" : 20,
         "description" : "Best State License",
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldId" : "best_state_license__v",
         "fieldSet" : null,
         "required" : false,
         "readOnly" : false,
         "expression" : null,
         "type" : {
            "dataType" : "REFERENCE",
            "discriminator" : "BooleanReference"
         },
         "countries" : {
            "GB" : {
               "expressionFlags" : 0,
               "allowedObjectTypes" : [],
               "available" : false,
               "defaultValue" : null,
               "required" : false,
               "readOnly" : false,
               "expression" : null,
               "country" : "GB"
            },
            "US" : {
               "expression" : null,
               "country" : "US",
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "available" : true,
               "defaultValue" : null,
               "expressionFlags" : 0,
               "readOnly" : true,
               "required" : false
            }
         },
         "customerOwned" : false,
         "defaultValue" : null,
         "expressionFlags" : 0,
         "sinceVersion" : "1.5.2",
         "labels" : {
            "tr" : "En iyi eyalet Lisansı?",
            "de" : "Beste staatliche Lizenz?",
            "en" : "Best State License?",
            "zh" : "最佳州许可?",
            "pt-BR" : "Melhor licença estadual?",
            "es" : "¿Mejor licencia de la provincia?",
            "pt" : "Melhor licença distrital?",
            "it" : "Migliore licenza di stato?",
            "fr" : "Meilleure licence d'état ?",
            "nl" : "Best State License?",
            "ja" : "最高の都道府県ライセンス?"
         },
         "fieldGroup" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true
      },
      {
         "blankAllowed" : true,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "fieldGroup" : null,
         "labels" : {
            "es" : "Organismo emisor de licencias",
            "pt-BR" : "Órgão licenciador",
            "pt" : "Entidade emissora",
            "en" : "Licensing Body",
            "tr" : "Lisans Veren Kuruluş",
            "de" : "Zulassungsstelle",
            "zh" : "许可证颁发机构",
            "ja" : "ライセンス管理法",
            "it" : "Corpo di licenza",
            "nl" : "Licentieverlener",
            "fr" : "Organisme d'attribution des licences"
         },
         "sinceVersion" : "1.0.0",
         "expressionFlags" : 0,
         "defaultValue" : null,
         "customerOwned" : false,
         "countries" : {
            "US" : {
               "expressionFlags" : 0,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "defaultValue" : null,
               "available" : true,
               "required" : false,
               "readOnly" : true,
               "expression" : null,
               "country" : "US"
            },
            "GB" : {
               "country" : "GB",
               "expression" : null,
               "required" : false,
               "readOnly" : false,
               "allowedObjectTypes" : [],
               "available" : false,
               "defaultValue" : null,
               "expressionFlags" : 0
            }
         },
         "type" : {
            "discriminator" : null,
            "dataType" : "STRING"
         },
         "expression" : null,
         "readOnly" : false,
         "fieldSet" : null,
         "required" : false,
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldId" : "body__v",
         "description" : "Licensing body full name",
         "maximumLength" : 200,
         "ownerOnlyEdit" : false,
         "status" : "ACTIVE"
      },
      {
         "fieldId" : "boolean_child__c",
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT",
                  "ADDRESS" : "DEFAULT",
                  "PARENTHCO" : "DEFAULT"
               }
            }
         },
         "fieldSet" : null,
         "required" : false,
         "readOnly" : false,
         "description" : "boolean value",
         "ownerOnlyEdit" : false,
         "maximumLength" : 20,
         "status" : "ACTIVE",
         "fieldGroup" : null,
         "blankAllowed" : true,
         "dataPrivacyFlag" : "NONE",
         "defaultValue" : null,
         "labels" : {
            "en" : "Custom Checkbox "
         },
         "sinceVersion" : null,
         "expressionFlags" : 0,
         "customerOwned" : true,
         "countries" : {
            "US" : {
               "expression" : null,
               "country" : "US",
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "expressionFlags" : 0,
               "required" : false,
               "readOnly" : false
            },
            "GB" : {
               "allowedObjectTypes" : [],
               "available" : false,
               "defaultValue" : null,
               "expressionFlags" : 0,
               "readOnly" : false,
               "required" : false,
               "expression" : null,
               "country" : "GB"
            }
         },
         "expression" : null,
         "type" : {
            "discriminator" : "BooleanReference",
            "dataType" : "REFERENCE"
         }
      },
      {
         "type" : {
            "dataType" : "DATETIME",
            "discriminator" : null
         },
         "expression" : null,
         "customerOwned" : false,
         "countries" : {
            "US" : {
               "expression" : null,
               "country" : "US",
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "CUSTOMAFFILIATION",
                  "CUSTOMKEY",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "defaultValue" : null,
               "available" : true,
               "expressionFlags" : 0,
               "required" : false,
               "readOnly" : true
            },
            "GB" : {
               "expression" : null,
               "country" : "GB",
               "available" : true,
               "defaultValue" : null,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "CUSTOMKEY",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "expressionFlags" : 0,
               "readOnly" : true,
               "required" : false
            }
         },
         "sinceVersion" : "1.0.0",
         "labels" : {
            "ja" : "作成日",
            "it" : "Data creazione",
            "nl" : "Datum gemaakt",
            "fr" : "Date de création",
            "pt" : "Data de criação",
            "zh_HK" : "建立日期",
            "es" : "Fecha de creación",
            "pt-BR" : "Data de criação",
            "zh" : "创建日期",
            "tr" : "Yaratım Tarihi",
            "de" : "Erstelldatum",
            "en" : "Created Date"
         },
         "expressionFlags" : 0,
         "defaultValue" : null,
         "blankAllowed" : true,
         "dataPrivacyFlag" : "NONE",
         "fieldGroup" : null,
         "status" : "ACTIVE",
         "maximumLength" : 25,
         "ownerOnlyEdit" : false,
         "description" : "Date this record was created",
         "required" : false,
         "fieldSet" : null,
         "readOnly" : true,
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "PARENTHCO" : "DEFAULT",
                  "HCP" : "DEFAULT",
                  "ADDRESS" : "DEFAULT",
                  "HCO" : "DEFAULT",
                  "LICENSE" : "DEFAULT",
                  "CUSTOMKEY" : "DEFAULT"
               }
            }
         },
         "fieldId" : "created_date__v"
      },
      {
         "type" : {
            "discriminator" : null,
            "dataType" : "SET"
         },
         "expression" : null,
         "customerOwned" : false,
         "countries" : {
            "GB" : {
               "country" : "GB",
               "expression" : null,
               "required" : false,
               "readOnly" : false,
               "available" : true,
               "defaultValue" : null,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "expressionFlags" : 0
            },
            "US" : {
               "expression" : null,
               "country" : "US",
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "CUSTOMAFFILIATION",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "defaultValue" : null,
               "available" : true,
               "expressionFlags" : 0,
               "readOnly" : false,
               "required" : false
            }
         },
         "sinceVersion" : "1.0.0",
         "labels" : {
            "ja" : "カスタムキーのセット",
            "fr" : "Ensemble de clés personnalisées",
            "nl" : "Set aangepaste sleutels",
            "it" : "Serie di chiavi personalizzate",
            "pt" : "Conjunto de chaves personalizadas",
            "es" : "Conjunto de claves externas",
            "zh_HK" : "自訂金鑰集",
            "pt-BR" : "Conjunto de chaves personalizadas",
            "zh" : "自定义密钥集",
            "tr" : "Özel Anahtarlar Seti",
            "de" : "Benutzerdefinierter Schlüsselsatz",
            "en" : "Set of Custom Keys"
         },
         "expressionFlags" : 0,
         "defaultValue" : null,
         "blankAllowed" : true,
         "dataPrivacyFlag" : "NONE",
         "fieldGroup" : null,
         "status" : "ACTIVE",
         "maximumLength" : null,
         "ownerOnlyEdit" : false,
         "description" : "Set of custom keys for this Record",
         "fieldSet" : null,
         "required" : false,
         "readOnly" : false,
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT",
                  "ADDRESS" : "DEFAULT",
                  "HCO" : "DEFAULT",
                  "HCP" : "DEFAULT",
                  "PARENTHCO" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldId" : "custom_keys__v"
      },
      {
         "description" : "DEA Business Activity Code",
         "readOnly" : false,
         "fieldSet" : null,
         "required" : false,
         "fieldId" : "dea_business_activity_code__v",
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            }
         },
         "status" : "ACTIVE",
         "maximumLength" : 100,
         "ownerOnlyEdit" : false,
         "expressionFlags" : 0,
         "sinceVersion" : "1.5.2",
         "labels" : {
            "ja" : "DEA 活動コード",
            "nl" : "DEA-activiteitscode",
            "fr" : "Code d'activité DEA",
            "it" : "Codice attività DEA",
            "pt" : "Código de atividade DEA",
            "pt-BR" : "Código de atividade DEA",
            "es" : "Código de actividad DEA",
            "zh" : "DEA 活动代码",
            "tr" : "DEA Activity Code",
            "en" : "DEA Activity Code",
            "de" : "DEA-Aktivitätscode"
         },
         "defaultValue" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true,
         "fieldGroup" : null,
         "type" : {
            "dataType" : "REFERENCE",
            "discriminator" : "LicenseDEACode"
         },
         "expression" : null,
         "countries" : {
            "US" : {
               "country" : "US",
               "expression" : null,
               "required" : false,
               "readOnly" : true,
               "expressionFlags" : 0,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "defaultValue" : null,
               "available" : true
            },
            "GB" : {
               "country" : "GB",
               "expression" : null,
               "required" : false,
               "readOnly" : false,
               "expressionFlags" : 0,
               "allowedObjectTypes" : [],
               "defaultValue" : null,
               "available" : false
            }
         },
         "customerOwned" : false
      },
      {
         "expression" : null,
         "type" : {
            "discriminator" : "LicenseDEAPaymentIndicator",
            "dataType" : "REFERENCE"
         },
         "customerOwned" : false,
         "countries" : {
            "US" : {
               "country" : "US",
               "expression" : null,
               "required" : false,
               "readOnly" : false,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "available" : true,
               "defaultValue" : null,
               "expressionFlags" : 0
            },
            "GB" : {
               "required" : false,
               "readOnly" : false,
               "expressionFlags" : 0,
               "allowedObjectTypes" : [],
               "available" : false,
               "defaultValue" : null,
               "country" : "GB",
               "expression" : null
            }
         },
         "defaultValue" : null,
         "sinceVersion" : "8.0.0",
         "labels" : {
            "pt" : "Indicador de pagamento DEA",
            "pt-BR" : "Indicador de pagamento da DEA",
            "es" : "Indicador de pago de DEA",
            "zh_HK" : "DEA 付款指標",
            "zh" : "DEA 付款指示",
            "de" : "DEA-Zahlungskennzeichen",
            "tr" : "DEA Ödeme Yetkisi",
            "en" : "DEA Payment Indicator",
            "ja" : "DEA 支払いインジケータ",
            "fr" : "Indicateur de paiement DEA",
            "nl" : "Indicator DEA-betaling",
            "it" : "Indicatore di pagamento DEA"
         },
         "expressionFlags" : 0,
         "fieldGroup" : null,
         "blankAllowed" : true,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "status" : "ACTIVE",
         "ownerOnlyEdit" : false,
         "maximumLength" : 100,
         "description" : "Sourced from a field in the DEA file layout that identifies if payment is required or is exempt.",
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            }
         },
         "fieldId" : "dea_payment_indicator__v",
         "fieldSet" : null,
         "required" : false,
         "readOnly" : false
      },
      {
         "customerOwned" : false,
         "countries" : {
            "GB" : {
               "country" : "GB",
               "expression" : null,
               "required" : false,
               "readOnly" : false,
               "expressionFlags" : 0,
               "defaultValue" : null,
               "available" : false,
               "allowedObjectTypes" : []
            },
            "US" : {
               "country" : "US",
               "expression" : null,
               "required" : false,
               "readOnly" : true,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "expressionFlags" : 0
            }
         },
         "type" : {
            "dataType" : "STRING",
            "discriminator" : null
         },
         "expression" : null,
         "blankAllowed" : true,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "fieldGroup" : null,
         "labels" : {
            "pt-BR" : "Detalhes da agenda do medicamento",
            "es" : "Detalles de programa de medicamentos",
            "pt" : "Detalhes do regime do medicamento",
            "de" : "Details des Medikamentenplans",
            "tr" : "İlaç Zamanlama Detayı",
            "en" : "Drug Schedule Details",
            "zh" : "药物计划详情",
            "ja" : "投薬スケジュールの詳細",
            "it" : "Dettagli programma medicinali",
            "fr" : "Détails sur le tableau des médicaments",
            "nl" : "Details medicatieschema"
         },
         "sinceVersion" : "1.0.0",
         "expressionFlags" : 0,
         "defaultValue" : null,
         "maximumLength" : 150,
         "ownerOnlyEdit" : false,
         "status" : "ACTIVE",
         "fieldSet" : null,
         "readOnly" : false,
         "required" : false,
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            }
         },
         "fieldId" : "drug_schedule__v",
         "description" : "Drug schedules for which this license has been granted"
      },
      {
         "countries" : {
            "US" : {
               "country" : "US",
               "expression" : null,
               "readOnly" : true,
               "required" : false,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "available" : true,
               "defaultValue" : null,
               "expressionFlags" : 0
            },
            "GB" : {
               "expression" : null,
               "country" : "GB",
               "available" : true,
               "defaultValue" : null,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "expressionFlags" : 0,
               "required" : false,
               "readOnly" : true
            }
         },
         "customerOwned" : false,
         "expression" : null,
         "type" : {
            "dataType" : "DATE",
            "discriminator" : null
         },
         "fieldGroup" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true,
         "defaultValue" : null,
         "expressionFlags" : 0,
         "sinceVersion" : "1.0.0",
         "labels" : {
            "zh" : "生效日期",
            "en" : "Effective Date",
            "tr" : "Geçerli Tarih",
            "de" : "Stichtag",
            "pt" : "Data de início",
            "pt-BR" : "Data de entrada em vigor",
            "es" : "Fecha de entrada en vigor",
            "zh_HK" : "生效日期",
            "fr" : "Date de validité",
            "nl" : "Ingangsdatum",
            "it" : "Data effettiva",
            "ja" : "有効日"
         },
         "ownerOnlyEdit" : false,
         "maximumLength" : 25,
         "status" : "ACTIVE",
         "fieldId" : "effective_date__v",
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldSet" : null,
         "readOnly" : false,
         "required" : false,
         "description" : "Effective date for the license"
      },
      {
         "expression" : null,
         "type" : {
            "dataType" : "REFERENCE",
            "discriminator" : "EntityType"
         },
         "countries" : {
            "US" : {
               "readOnly" : true,
               "required" : false,
               "expressionFlags" : 0,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "country" : "US",
               "expression" : null
            },
            "GB" : {
               "expressionFlags" : 0,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "readOnly" : true,
               "required" : false,
               "expression" : null,
               "country" : "GB"
            }
         },
         "customerOwned" : false,
         "defaultValue" : null,
         "expressionFlags" : 0,
         "sinceVersion" : "1.0.0",
         "labels" : {
            "ja" : "エンティティタイプ",
            "it" : "Tipo entità",
            "fr" : "Type d'entité",
            "nl" : "Entiteitstype",
            "pt" : "Tipo de entidade",
            "es" : "Tipo de entidad",
            "pt-BR" : "Tipo de entidade",
            "zh_HK" : "實體類型",
            "zh" : "实体类型",
            "de" : "Entitätstyp",
            "tr" : "Madde Tipi",
            "en" : "Entity Type"
         },
         "fieldGroup" : null,
         "dataPrivacyFlag" : "NONE",
         "blankAllowed" : true,
         "status" : "ACTIVE",
         "ownerOnlyEdit" : false,
         "maximumLength" : 10,
         "description" : "Entity Type",
         "fieldId" : "entity_type__v",
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT",
                  "CONTACT" : "DEFAULT",
                  "PARENTHCO" : "DEFAULT",
                  "ADDRESS" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldSet" : null,
         "required" : false,
         "readOnly" : true
      },
      {
         "type" : {
            "discriminator" : null,
            "dataType" : "VEEVAID"
         },
         "expression" : null,
         "countries" : {
            "GB" : {
               "expression" : null,
               "country" : "GB",
               "expressionFlags" : 0,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "defaultValue" : null,
               "available" : true,
               "readOnly" : true,
               "required" : false
            },
            "US" : {
               "expressionFlags" : 0,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "available" : true,
               "defaultValue" : null,
               "required" : false,
               "readOnly" : true,
               "expression" : null,
               "country" : "US"
            }
         },
         "customerOwned" : false,
         "expressionFlags" : 0,
         "labels" : {
            "ja" : "所有者の Network ID",
            "it" : "ID rete del proprietario",
            "nl" : "Network-ID van eigenaar",
            "fr" : "ID Network du propriétaire",
            "es" : "ID de la entidad",
            "pt-BR" : "ID do Network do proprietário",
            "zh_HK" : "擁有者的 Network 識別碼",
            "pt" : "ID de rede do proprietário",
            "tr" : "Sahibin Network ID'si",
            "de" : "Netzwerk-ID des Eigentümers",
            "en" : "Network ID of owner",
            "zh" : "所有者 Network ID"
         },
         "sinceVersion" : "1.0.0",
         "defaultValue" : null,
         "dataPrivacyFlag" : "NONE",
         "blankAllowed" : true,
         "fieldGroup" : null,
         "status" : "ACTIVE",
         "maximumLength" : 18,
         "ownerOnlyEdit" : false,
         "description" : "Entity Id",
         "readOnly" : true,
         "fieldSet" : null,
         "required" : false,
         "fieldId" : "entity_vid__v",
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "ADDRESS" : "DEFAULT",
                  "PARENTHCO" : "DEFAULT",
                  "LICENSE" : "DEFAULT"
               }
            }
         }
      },
      {
         "description" : "Expiration date for the license",
         "fieldId" : "expiration_date__v",
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            }
         },
         "fieldSet" : null,
         "readOnly" : false,
         "required" : false,
         "status" : "ACTIVE",
         "ownerOnlyEdit" : false,
         "maximumLength" : 25,
         "defaultValue" : null,
         "expressionFlags" : 0,
         "sinceVersion" : "1.0.0",
         "labels" : {
            "de" : "Ablaufdatum",
            "tr" : "Bitiş Tarihi",
            "en" : "Expiration Date",
            "zh" : "过期日期",
            "pt-BR" : "Data de validade",
            "es" : "Fecha de expiración",
            "zh_HK" : "到期日",
            "pt" : "Data do fim",
            "it" : "Data di scadenza",
            "nl" : "Vervaldatum",
            "fr" : "Date d'expiration",
            "ja" : "有効期限"
         },
         "fieldGroup" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true,
         "expression" : null,
         "type" : {
            "dataType" : "DATE",
            "discriminator" : null
         },
         "countries" : {
            "GB" : {
               "required" : false,
               "readOnly" : false,
               "expressionFlags" : 0,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "defaultValue" : null,
               "available" : true,
               "country" : "GB",
               "expression" : null
            },
            "US" : {
               "expression" : null,
               "country" : "US",
               "expressionFlags" : 0,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "readOnly" : false,
               "required" : false
            }
         },
         "customerOwned" : false
      },
      {
         "description" : "Grace Period",
         "fieldSet" : null,
         "readOnly" : false,
         "required" : false,
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldId" : "grace_period__v",
         "status" : "ACTIVE",
         "maximumLength" : 25,
         "ownerOnlyEdit" : false,
         "expressionFlags" : 0,
         "labels" : {
            "en" : "Grace Expiry",
            "tr" : "Ödemesiz Süre Bitimi",
            "de" : "Fristablauf",
            "zh" : "宽限期到期",
            "es" : "Período de gracia",
            "pt-BR" : "Vencimento da carência",
            "pt" : "Expiração do período de carência",
            "it" : "Scadenza del termine supplementare",
            "fr" : "Expiration du délai de grâce",
            "nl" : "Vervaldatum respijtperiode",
            "ja" : "猶予期限"
         },
         "sinceVersion" : "1.0.0",
         "defaultValue" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true,
         "fieldGroup" : null,
         "type" : {
            "discriminator" : null,
            "dataType" : "DATE"
         },
         "expression" : null,
         "countries" : {
            "GB" : {
               "country" : "GB",
               "expression" : null,
               "readOnly" : false,
               "required" : false,
               "allowedObjectTypes" : [],
               "defaultValue" : null,
               "available" : false,
               "expressionFlags" : 0
            },
            "US" : {
               "required" : false,
               "readOnly" : true,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "expressionFlags" : 0,
               "country" : "US",
               "expression" : null
            }
         },
         "customerOwned" : false
      },
      {
         "expressionFlags" : 0,
         "sinceVersion" : "1.0.0",
         "labels" : {
            "nl" : "Oorspronkelijke licentiedatum",
            "fr" : "Date initiale d'obtention de licence du comité",
            "it" : "Data iniziale licenza istituto",
            "ja" : "イニシャルボードライセンス日",
            "tr" : "Initial Board Licensing Date",
            "en" : "Initial Board Licensing Date",
            "de" : "Ursprüngliches Datum der Lizenzierung durch Vorstand",
            "zh" : "初始董事会许可日期",
            "es" : "Fecha de emisión de la licencia",
            "pt-BR" : "Dados de licenciamento inicial do conselho",
            "pt" : "Data inicial de licenciamento do conselho"
         },
         "defaultValue" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true,
         "fieldGroup" : null,
         "type" : {
            "dataType" : "DATE",
            "discriminator" : null
         },
         "expression" : null,
         "countries" : {
            "GB" : {
               "country" : "GB",
               "expression" : null,
               "readOnly" : false,
               "required" : false,
               "expressionFlags" : 0,
               "allowedObjectTypes" : [],
               "defaultValue" : null,
               "available" : false
            },
            "US" : {
               "expressionFlags" : 0,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "readOnly" : true,
               "required" : false,
               "expression" : null,
               "country" : "US"
            }
         },
         "customerOwned" : false,
         "description" : "Date license was first granted by the state licensing board",
         "fieldSet" : null,
         "readOnly" : false,
         "required" : false,
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            }
         },
         "fieldId" : "initial_board_license_date__v",
         "status" : "ACTIVE",
         "maximumLength" : 25,
         "ownerOnlyEdit" : false
      },
      {
         "defaultValue" : null,
         "expressionFlags" : 0,
         "sinceVersion" : "1.5.3",
         "labels" : {
            "ja" : "マスターが外部のレコード?",
            "fr" : "Enregistrement géré en externe?",
            "nl" : "Extern gemasterd record?",
            "it" : "Record master esterno?",
            "es" : "¿Registro controlado externamente?",
            "pt-BR" : "Registro masterizado externamente?",
            "zh_HK" : "外部主控記錄?",
            "pt" : "Registo masterizado externamente?",
            "de" : "Extern gemasterter Datensatz?",
            "tr" : "Dışarıdan Yönetilen Kayıt?",
            "en" : "Externally Mastered Record?",
            "zh" : "外部掌握的记录?"
         },
         "fieldGroup" : null,
         "dataPrivacyFlag" : "NONE",
         "blankAllowed" : true,
         "expression" : null,
         "type" : {
            "dataType" : "BOOLEAN",
            "discriminator" : null
         },
         "countries" : {
            "US" : {
               "readOnly" : true,
               "required" : false,
               "expressionFlags" : 0,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "defaultValue" : null,
               "available" : true,
               "country" : "US",
               "expression" : null
            },
            "GB" : {
               "country" : "GB",
               "expression" : null,
               "required" : false,
               "readOnly" : true,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "expressionFlags" : 0
            }
         },
         "customerOwned" : false,
         "description" : "Is this an externally mastered record",
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "ADDRESS" : "DEFAULT",
                  "HCO" : "DEFAULT",
                  "LICENSE" : "DEFAULT",
                  "PARENTHCO" : "DEFAULT",
                  "HCP" : "DEFAULT"
               }
            }
         },
         "fieldId" : "is_externally_mastered__v",
         "required" : false,
         "fieldSet" : null,
         "readOnly" : true,
         "status" : "ACTIVE",
         "ownerOnlyEdit" : false,
         "maximumLength" : 10
      },
      {
         "dataPrivacyFlag" : "NONE",
         "blankAllowed" : true,
         "fieldGroup" : null,
         "expressionFlags" : 0,
         "labels" : {
            "zh_HK" : "專有記錄?",
            "es" : "¿Registro propio?",
            "pt-BR" : "Registro proprietário?",
            "pt" : "Registo proprietário?",
            "tr" : "Sahip olunan kayıt?",
            "de" : "Proprietärer Datensatz?",
            "en" : "Proprietary Record?",
            "zh" : "专有记录?",
            "ja" : "所有レコード?",
            "it" : "Record proprietario?",
            "nl" : "Eigen record?",
            "fr" : "Enregistrement propriétaire ?"
         },
         "sinceVersion" : "2.5.1",
         "defaultValue" : null,
         "countries" : {
            "GB" : {
               "available" : true,
               "defaultValue" : null,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "expressionFlags" : 0,
               "readOnly" : true,
               "required" : false,
               "expression" : null,
               "country" : "GB"
            },
            "US" : {
               "readOnly" : true,
               "required" : false,
               "expressionFlags" : 0,
               "available" : true,
               "defaultValue" : null,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "country" : "US",
               "expression" : null
            }
         },
         "customerOwned" : false,
         "type" : {
            "dataType" : "BOOLEAN",
            "discriminator" : null
         },
         "expression" : null,
         "fieldSet" : null,
         "readOnly" : true,
         "required" : false,
         "fieldId" : "is_proprietary__v",
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "ADDRESS" : "DEFAULT",
                  "HCO" : "DEFAULT",
                  "LICENSE" : "DEFAULT",
                  "PARENTHCO" : "DEFAULT",
                  "HCP" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "description" : "Is this data proprietary to the customer",
         "maximumLength" : 10,
         "ownerOnlyEdit" : false,
         "status" : "ACTIVE"
      },
      {
         "status" : "ACTIVE",
         "maximumLength" : 10,
         "ownerOnlyEdit" : false,
         "description" : "Is this a Veeva mastered record",
         "fieldSet" : null,
         "readOnly" : true,
         "required" : false,
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT",
                  "CONTACT" : "DEFAULT",
                  "HCO" : "DEFAULT",
                  "ADDRESS" : "DEFAULT",
                  "HCP" : "DEFAULT",
                  "PARENTHCO" : "DEFAULT"
               }
            }
         },
         "fieldId" : "is_veeva_master__v",
         "type" : {
            "discriminator" : null,
            "dataType" : "BOOLEAN"
         },
         "expression" : null,
         "countries" : {
            "US" : {
               "required" : false,
               "readOnly" : true,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "CUSTOMAFFILIATION",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "expressionFlags" : 0,
               "country" : "US",
               "expression" : null
            },
            "GB" : {
               "expressionFlags" : 0,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "defaultValue" : null,
               "available" : true,
               "required" : false,
               "readOnly" : true,
               "expression" : null,
               "country" : "GB"
            }
         },
         "customerOwned" : false,
         "expressionFlags" : 0,
         "sinceVersion" : "1.0.0",
         "labels" : {
            "ja" : "Veeva のマスターレコード?",
            "fr" : "Enregistrement principal Veeva ?",
            "nl" : "Veeva-masterrecord?",
            "it" : "Record Veeva Master?",
            "pt" : "Registo do Veeva Master?",
            "es" : "¿Registro controlado por Veeva?",
            "pt-BR" : "Registro mestre da Veeva?",
            "zh_HK" : "Veeva 主要記錄?",
            "zh" : "Veeva 主记录?",
            "tr" : "Veeva Master Kayıt?",
            "de" : "Veeva-Master-Datensatz?",
            "en" : "Veeva Master Record?"
         },
         "defaultValue" : null,
         "dataPrivacyFlag" : "NONE",
         "blankAllowed" : true,
         "fieldGroup" : null
      },
      {
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT",
                  "HCP" : "DEFAULT",
                  "ADDRESS" : "DEFAULT",
                  "HCO" : "DEFAULT",
                  "PARENTHCO" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldId" : "last_val_date__c",
         "required" : false,
         "fieldSet" : null,
         "readOnly" : false,
         "description" : "Last validated date of the field in focus.",
         "ownerOnlyEdit" : false,
         "maximumLength" : 25,
         "status" : "ACTIVE",
         "fieldGroup" : null,
         "dataPrivacyFlag" : "NONE",
         "blankAllowed" : true,
         "defaultValue" : null,
         "expressionFlags" : 0,
         "labels" : {
            "en" : "Last Validated Date"
         },
         "sinceVersion" : null,
         "countries" : {
            "GB" : {
               "expression" : null,
               "country" : "GB",
               "expressionFlags" : 0,
               "available" : false,
               "defaultValue" : null,
               "allowedObjectTypes" : [],
               "required" : false,
               "readOnly" : false
            },
            "US" : {
               "expression" : "Null",
               "country" : "US",
               "available" : true,
               "defaultValue" : null,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "expressionFlags" : 0,
               "readOnly" : false,
               "required" : false
            }
         },
         "customerOwned" : true,
         "expression" : null,
         "type" : {
            "dataType" : "DATETIME",
            "discriminator" : null
         }
      },
      {
         "blankAllowed" : true,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "fieldGroup" : null,
         "labels" : {
            "it" : "Regione di abilitazione professionale",
            "fr" : "Région de l'homologation",
            "nl" : "Regio van licentiaat",
            "ja" : "ライセンス交付地区",
            "zh" : "许可地区",
            "tr" : "Lisans Bölgesi",
            "de" : "Lizenzierungsregion",
            "en" : "Region of Licensure",
            "pt" : "Região do licenciamento",
            "zh_HK" : "許可的地區",
            "es" : "Región de concesión de licencia",
            "pt-BR" : "Região de licenciamento"
         },
         "sinceVersion" : "7.5.2",
         "expressionFlags" : 0,
         "defaultValue" : null,
         "customerOwned" : false,
         "countries" : {
            "GB" : {
               "country" : "GB",
               "expression" : null,
               "readOnly" : false,
               "required" : false,
               "expressionFlags" : 0,
               "defaultValue" : null,
               "available" : false,
               "allowedObjectTypes" : []
            },
            "US" : {
               "required" : false,
               "readOnly" : false,
               "allowedObjectTypes" : [],
               "available" : false,
               "defaultValue" : null,
               "expressionFlags" : 0,
               "country" : "US",
               "expression" : null
            }
         },
         "type" : {
            "dataType" : "REFERENCE",
            "discriminator" : "AddressAdminArea"
         },
         "expression" : null,
         "readOnly" : false,
         "fieldSet" : null,
         "required" : false,
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldId" : "license_admin_area__v",
         "description" : "Actual geographic code associated to this license (reference list).",
         "maximumLength" : 100,
         "ownerOnlyEdit" : false,
         "status" : "ACTIVE"
      },
      {
         "expressionFlags" : 0,
         "sinceVersion" : "19R3.0",
         "labels" : {
            "en" : "License Certification"
         },
         "defaultValue" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true,
         "fieldGroup" : null,
         "type" : {
            "discriminator" : "LicenseCertification",
            "dataType" : "REFERENCE"
         },
         "expression" : null,
         "countries" : {
            "GB" : {
               "required" : false,
               "readOnly" : false,
               "allowedObjectTypes" : [],
               "available" : false,
               "defaultValue" : null,
               "expressionFlags" : 0,
               "country" : "GB",
               "expression" : null
            },
            "US" : {
               "expression" : null,
               "country" : "US",
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "available" : true,
               "defaultValue" : null,
               "expressionFlags" : 0,
               "readOnly" : false,
               "required" : false
            }
         },
         "customerOwned" : false,
         "description" : "A credential or certification added to a license by a licensing board that qualifies an HCP to provide services beyond those granted to the HCP's primary qualifying degree and examination.",
         "required" : false,
         "fieldSet" : null,
         "readOnly" : false,
         "fieldId" : "license_certification__v",
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            }
         },
         "status" : "DEACTIVATED",
         "maximumLength" : 100,
         "ownerOnlyEdit" : false
      },
      {
         "fieldGroup" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true,
         "defaultValue" : null,
         "expressionFlags" : 0,
         "sinceVersion" : "1.0.0",
         "labels" : {
            "pt" : "Cédula Profissional",
            "es" : "Grado de licencia",
            "pt-BR" : "Licenciatura",
            "zh" : "许可等级",
            "tr" : "Lisans Derecesi",
            "en" : "License Degree",
            "de" : "Lizenzgrad",
            "ja" : "ライセンス等級",
            "it" : "Grado licenza",
            "nl" : "Licentiegraad",
            "fr" : "Licence"
         },
         "countries" : {
            "US" : {
               "country" : "US",
               "expression" : null,
               "readOnly" : true,
               "required" : false,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "expressionFlags" : 0
            },
            "GB" : {
               "required" : false,
               "readOnly" : false,
               "expressionFlags" : 0,
               "allowedObjectTypes" : [],
               "available" : false,
               "defaultValue" : null,
               "country" : "GB",
               "expression" : null
            }
         },
         "customerOwned" : false,
         "expression" : null,
         "type" : {
            "discriminator" : null,
            "dataType" : "STRING"
         },
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            }
         },
         "fieldId" : "license_degree__v",
         "required" : false,
         "fieldSet" : null,
         "readOnly" : false,
         "description" : "License degree",
         "ownerOnlyEdit" : false,
         "maximumLength" : 150,
         "status" : "ACTIVE"
      },
      {
         "expressionFlags" : 0,
         "labels" : {
            "nl" : "Voorschrijvende autoriteit",
            "fr" : "Autorité de prescription",
            "ja" : "処方権",
            "no" : "reseptbelagt myndighet",
            "tr" : "Reçeteleme Yetkilisi",
            "pt" : "Autoridade prescritiva",
            "fi" : "Ohjaileva viranomainen",
            "it" : "Autorità prescrittiva",
            "da" : "Normgivende autoritet",
            "zh" : "处方权",
            "de" : "Verschreibungsbefugnis",
            "en" : "Prescriptive Authority",
            "es" : "Autoridad de prescripción",
            "pt-BR" : "Autoridade normativa",
            "zh_HK" : "規範主管機關",
            "sv" : "Förskrivande myndighet"
         },
         "sinceVersion" : "1.0.0",
         "defaultValue" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true,
         "fieldGroup" : null,
         "type" : {
            "dataType" : "REFERENCE",
            "discriminator" : "LicenseEligibility"
         },
         "expression" : null,
         "countries" : {
            "GB" : {
               "country" : "GB",
               "expression" : null,
               "readOnly" : false,
               "required" : false,
               "available" : false,
               "defaultValue" : null,
               "allowedObjectTypes" : [],
               "expressionFlags" : 0
            },
            "US" : {
               "expression" : null,
               "country" : "US",
               "expressionFlags" : 0,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "defaultValue" : null,
               "available" : true,
               "readOnly" : true,
               "required" : false
            }
         },
         "customerOwned" : false,
         "description" : "Reflects HCP's prescriptive authority eligibility by state/degree/credential. Considers expiration date/grace period and license status and conditions.",
         "fieldSet" : null,
         "readOnly" : false,
         "required" : false,
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldId" : "license_eligibility__v",
         "status" : "ACTIVE",
         "maximumLength" : 100,
         "ownerOnlyEdit" : false
      },
      {
         "status" : "ACTIVE",
         "ownerOnlyEdit" : false,
         "maximumLength" : 20,
         "description" : "Actual license number",
         "fieldId" : "license_number__v",
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "readOnly" : false,
         "fieldSet" : null,
         "required" : false,
         "expression" : null,
         "type" : {
            "dataType" : "STRING",
            "discriminator" : null
         },
         "countries" : {
            "GB" : {
               "expressionFlags" : 0,
               "available" : true,
               "defaultValue" : null,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "required" : false,
               "readOnly" : false,
               "expression" : null,
               "country" : "GB"
            },
            "US" : {
               "required" : false,
               "readOnly" : false,
               "expressionFlags" : 0,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "country" : "US",
               "expression" : null
            }
         },
         "customerOwned" : false,
         "defaultValue" : null,
         "expressionFlags" : 0,
         "sinceVersion" : "1.0.0",
         "labels" : {
            "zh" : "执照",
            "en" : "License",
            "tr" : "Lisans",
            "de" : "Lizenz",
            "pt" : "Nº da Cédula Profissional",
            "pt-BR" : "Licença",
            "es" : "Número de licencia",
            "zh_HK" : "授權",
            "nl" : "Licentie",
            "fr" : "Licence",
            "it" : "Licenza",
            "ja" : "ライセンス"
         },
         "fieldGroup" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true
      },
      {
         "status" : "ACTIVE",
         "maximumLength" : 100,
         "ownerOnlyEdit" : false,
         "description" : "License status",
         "fieldSet" : null,
         "required" : false,
         "readOnly" : false,
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            }
         },
         "fieldId" : "license_status__v",
         "type" : {
            "dataType" : "REFERENCE",
            "discriminator" : "LicenseStatus"
         },
         "expression" : null,
         "countries" : {
            "GB" : {
               "expression" : null,
               "country" : "GB",
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "defaultValue" : "A",
               "available" : true,
               "expressionFlags" : 0,
               "readOnly" : true,
               "required" : false
            },
            "US" : {
               "defaultValue" : "A",
               "available" : true,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "expressionFlags" : 0,
               "readOnly" : true,
               "required" : false,
               "expression" : null,
               "country" : "US"
            }
         },
         "customerOwned" : false,
         "expressionFlags" : 0,
         "sinceVersion" : "1.0.0",
         "labels" : {
            "nl" : "Licentiestatus",
            "fr" : "Statut de la licence",
            "it" : "Stato licenza",
            "ja" : "ライセンスステータス",
            "tr" : "Lisans Statüsü",
            "en" : "License Status",
            "de" : "Lizenzstatus",
            "zh" : "执照状态",
            "es" : "Estado de la licencia",
            "pt-BR" : "Status da licença",
            "zh_HK" : "授權狀態",
            "pt" : "Estado da autorização"
         },
         "defaultValue" : "A",
         "dataPrivacyFlag" : "NONE",
         "blankAllowed" : true,
         "fieldGroup" : null
      },
      {
         "expression" : null,
         "type" : {
            "discriminator" : "LicenseStatusCondition",
            "dataType" : "REFERENCE"
         },
         "countries" : {
            "GB" : {
               "required" : false,
               "readOnly" : true,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "expressionFlags" : 0,
               "country" : "GB",
               "expression" : null
            },
            "US" : {
               "expression" : null,
               "country" : "US",
               "expressionFlags" : 0,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "defaultValue" : "0",
               "available" : true,
               "required" : false,
               "readOnly" : true
            }
         },
         "customerOwned" : false,
         "defaultValue" : null,
         "expressionFlags" : 0,
         "labels" : {
            "it" : "Condizione stato della licenza",
            "fr" : "Condition du statut de la licence",
            "nl" : "Voorwaarde licentiestatus",
            "ja" : "ライセンスステータス条件",
            "en" : "License Status Condition",
            "tr" : "Lisans Statü Durumu",
            "de" : "Lizenzstatusbedingung",
            "zh" : "执照状态条件",
            "es" : "Condición de estado de licencia",
            "pt-BR" : "Condição do status da licença",
            "pt" : "Condição da autorização"
         },
         "sinceVersion" : "4.0.0",
         "fieldGroup" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true,
         "status" : "ACTIVE",
         "ownerOnlyEdit" : false,
         "maximumLength" : 100,
         "description" : "Additional information about the license status.",
         "fieldId" : "license_status_condition__v",
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            }
         },
         "fieldSet" : null,
         "required" : false,
         "readOnly" : false
      },
      {
         "description" : "Subtype of License",
         "fieldId" : "license_subtype__v",
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            }
         },
         "readOnly" : false,
         "fieldSet" : null,
         "required" : false,
         "status" : "ACTIVE",
         "ownerOnlyEdit" : false,
         "maximumLength" : 100,
         "defaultValue" : null,
         "expressionFlags" : 0,
         "sinceVersion" : "4.0.0",
         "labels" : {
            "ja" : "ライセンスサブタイプ",
            "fr" : "Sous-type de licence",
            "nl" : "Subtype licentie",
            "it" : "Sottotipo di licenza",
            "pt" : "Subtipo de licenciatura",
            "zh_HK" : "授權子類型",
            "es" : "Subtipo de licencia",
            "pt-BR" : "Subtipo da licença",
            "zh" : "执照子类",
            "de" : "Lizenzuntertyp",
            "tr" : "Lisans Alt Tipi",
            "en" : "License SubType"
         },
         "fieldGroup" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true,
         "expression" : null,
         "type" : {
            "discriminator" : "LicenseSubType",
            "dataType" : "REFERENCE"
         },
         "countries" : {
            "GB" : {
               "defaultValue" : null,
               "available" : false,
               "allowedObjectTypes" : [],
               "expressionFlags" : 0,
               "readOnly" : false,
               "required" : false,
               "expression" : null,
               "country" : "GB"
            },
            "US" : {
               "expression" : null,
               "country" : "US",
               "expressionFlags" : 0,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "defaultValue" : "U",
               "available" : true,
               "required" : false,
               "readOnly" : true
            }
         },
         "customerOwned" : false
      },
      {
         "maximumLength" : 100,
         "ownerOnlyEdit" : false,
         "status" : "ACTIVE",
         "fieldSet" : null,
         "required" : false,
         "readOnly" : false,
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldId" : "licensing_body__v",
         "description" : "Licensing body",
         "countries" : {
            "US" : {
               "allowedObjectTypes" : [],
               "defaultValue" : null,
               "available" : false,
               "expressionFlags" : 0,
               "readOnly" : false,
               "required" : false,
               "expression" : null,
               "country" : "US"
            },
            "GB" : {
               "required" : false,
               "readOnly" : false,
               "expressionFlags" : 0,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "available" : true,
               "defaultValue" : null,
               "country" : "GB",
               "expression" : null
            }
         },
         "customerOwned" : false,
         "type" : {
            "dataType" : "REFERENCE",
            "discriminator" : "LicensingBody"
         },
         "expression" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true,
         "fieldGroup" : null,
         "expressionFlags" : 0,
         "sinceVersion" : "1.0.0",
         "labels" : {
            "nl" : "Licentieverlener",
            "fr" : "Organisme d'attribution des licences",
            "it" : "Corpo di licenza",
            "ja" : "ライセンス管理法",
            "de" : "Zulassungsstelle",
            "tr" : "Lisans Veren Kuruluş",
            "en" : "Licensing Body",
            "zh" : "许可证颁发机构",
            "es" : "Organismo emisor de licencias",
            "pt-BR" : "Órgão licenciador",
            "pt" : "Entidade emissora"
         },
         "defaultValue" : null
      },
      {
         "description" : "Date this record was last modified",
         "fieldId" : "modified_date__v",
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT",
                  "CUSTOMKEY" : "DEFAULT",
                  "ADDRESS" : "DEFAULT",
                  "HCO" : "DEFAULT",
                  "HCP" : "DEFAULT",
                  "PARENTHCO" : "DEFAULT"
               }
            }
         },
         "fieldSet" : null,
         "required" : false,
         "readOnly" : true,
         "status" : "ACTIVE",
         "ownerOnlyEdit" : false,
         "maximumLength" : 25,
         "defaultValue" : null,
         "expressionFlags" : 0,
         "sinceVersion" : "1.0.0",
         "labels" : {
            "it" : "Data modificata",
            "nl" : "Datum gewijzigd",
            "fr" : "Date de modification",
            "ja" : "変更日",
            "zh" : "修改日期",
            "tr" : "Değiştirilme Tarihi",
            "en" : "Modified Date",
            "de" : "Änderungsdatum",
            "pt" : "Data modificada",
            "es" : "Fecha de modificación",
            "zh_HK" : "修改日期",
            "pt-BR" : "Data de modificação"
         },
         "fieldGroup" : null,
         "dataPrivacyFlag" : "NONE",
         "blankAllowed" : true,
         "expression" : null,
         "type" : {
            "dataType" : "DATETIME",
            "discriminator" : null
         },
         "countries" : {
            "GB" : {
               "country" : "GB",
               "expression" : null,
               "readOnly" : true,
               "required" : false,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "CUSTOMKEY",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "expressionFlags" : 0
            },
            "US" : {
               "expression" : null,
               "country" : "US",
               "expressionFlags" : 0,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "CUSTOMAFFILIATION",
                  "CUSTOMKEY",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "required" : false,
               "readOnly" : true
            }
         },
         "customerOwned" : false
      },
      {
         "dataPrivacyFlag" : "NONE",
         "blankAllowed" : true,
         "fieldGroup" : null,
         "expressionFlags" : 0,
         "sinceVersion" : null,
         "labels" : {
            "en" : "Primary US License?"
         },
         "defaultValue" : null,
         "countries" : {
            "US" : {
               "available" : true,
               "defaultValue" : "U",
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "expressionFlags" : 0,
               "readOnly" : false,
               "required" : false,
               "expression" : null,
               "country" : "US"
            },
            "GB" : {
               "country" : "GB",
               "expression" : null,
               "readOnly" : false,
               "required" : false,
               "expressionFlags" : 0,
               "allowedObjectTypes" : [],
               "defaultValue" : null,
               "available" : false
            }
         },
         "customerOwned" : true,
         "type" : {
            "dataType" : "REFERENCE",
            "discriminator" : "BooleanReference"
         },
         "expression" : null,
         "required" : false,
         "fieldSet" : null,
         "readOnly" : false,
         "fieldId" : "primary_license__c",
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            }
         },
         "description" : "Is primary",
         "maximumLength" : 20,
         "ownerOnlyEdit" : false,
         "status" : "ACTIVE"
      },
      {
         "status" : "ACTIVE",
         "ownerOnlyEdit" : false,
         "maximumLength" : 18,
         "description" : "Delta Id",
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "HCP" : "DEFAULT",
                  "PARENTHCO" : "DEFAULT",
                  "LICENSE" : "DEFAULT",
                  "CONTACT" : "DEFAULT",
                  "HCO" : "DEFAULT",
                  "ADDRESS" : "DEFAULT"
               }
            }
         },
         "fieldId" : "record_delta_id__v",
         "required" : false,
         "fieldSet" : null,
         "readOnly" : true,
         "expression" : null,
         "type" : {
            "discriminator" : null,
            "dataType" : "VEEVAID"
         },
         "countries" : {
            "GB" : {
               "readOnly" : true,
               "required" : false,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "available" : true,
               "defaultValue" : null,
               "expressionFlags" : 0,
               "country" : "GB",
               "expression" : null
            },
            "US" : {
               "expression" : null,
               "country" : "US",
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "CUSTOMAFFILIATION",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "expressionFlags" : 0,
               "required" : false,
               "readOnly" : true
            }
         },
         "customerOwned" : false,
         "defaultValue" : null,
         "expressionFlags" : 0,
         "labels" : {
            "ja" : "デルタ ID",
            "it" : "ID Delta",
            "fr" : "ID delta",
            "nl" : "Delta-ID",
            "pt" : "ID Delta",
            "pt-BR" : "ID Delta",
            "es" : "ID Delta",
            "zh_HK" : "Delta 識別碼",
            "zh" : "增量 ID",
            "tr" : "Delta ID",
            "en" : "Delta ID",
            "de" : "Delta-ID"
         },
         "sinceVersion" : "1.0.0",
         "fieldGroup" : null,
         "dataPrivacyFlag" : "NONE",
         "blankAllowed" : true
      },
      {
         "fieldGroup" : null,
         "dataPrivacyFlag" : "NONE",
         "blankAllowed" : true,
         "defaultValue" : null,
         "expressionFlags" : 0,
         "labels" : {
            "zh" : "健在记录 Network ID",
            "de" : "Netzwerk-ID des verbleibenden Datensatzes",
            "tr" : "Kazanan Kayıt Network ID",
            "en" : "Surviving Record Network ID",
            "pt" : "ID de rede do registo sobrevivente",
            "pt-BR" : "ID do Network de registro remanescente",
            "es" : "ID del registro superviviente",
            "zh_HK" : "存活記錄 Network 識別碼",
            "it" : "ID rete record superstite",
            "nl" : "Network-ID overgebleven record",
            "fr" : "ID Network de l'enregistrement à conserver",
            "ja" : "存続レコードNetwork ID"
         },
         "sinceVersion" : "1.0.0",
         "countries" : {
            "US" : {
               "expressionFlags" : 0,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "CUSTOMAFFILIATION",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "readOnly" : true,
               "required" : false,
               "expression" : null,
               "country" : "US"
            },
            "GB" : {
               "country" : "GB",
               "expression" : null,
               "readOnly" : true,
               "required" : false,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "expressionFlags" : 0
            }
         },
         "customerOwned" : false,
         "expression" : null,
         "type" : {
            "discriminator" : null,
            "dataType" : "VEEVAID"
         },
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "PARENTHCO" : "DEFAULT",
                  "HCP" : "DEFAULT",
                  "ADDRESS" : "DEFAULT",
                  "HCO" : "DEFAULT",
                  "LICENSE" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldId" : "record_merged_vid__v",
         "fieldSet" : null,
         "required" : false,
         "readOnly" : true,
         "description" : "ID of record that this record was merged into",
         "ownerOnlyEdit" : false,
         "maximumLength" : 18,
         "status" : "ACTIVE"
      },
      {
         "expression" : null,
         "type" : {
            "discriminator" : null,
            "dataType" : "STRING"
         },
         "customerOwned" : false,
         "countries" : {
            "US" : {
               "readOnly" : true,
               "required" : false,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "CUSTOMAFFILIATION",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "expressionFlags" : 0,
               "country" : "US",
               "expression" : null
            },
            "GB" : {
               "required" : false,
               "readOnly" : true,
               "expressionFlags" : 0,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "country" : "GB",
               "expression" : null
            }
         },
         "defaultValue" : null,
         "labels" : {
            "it" : "Nome proprietario record",
            "fr" : "Nom du propriétaire de l'enregistrement",
            "nl" : "Naam recordeigenaar",
            "ja" : "レコード所有者名",
            "tr" : "Kayıt Sahibi Adı",
            "de" : "Name des Datensatzeigentümers",
            "en" : "Record Owner Name",
            "zh" : "记录所有者姓名",
            "zh_HK" : "記錄擁有者名稱",
            "es" : "Nombre de propietario de registro",
            "pt-BR" : "Nome do proprietário do registro",
            "pt" : "Nome do proprietário do registo"
         },
         "sinceVersion" : "17R2.0",
         "expressionFlags" : 0,
         "fieldGroup" : null,
         "blankAllowed" : true,
         "dataPrivacyFlag" : "NONE",
         "status" : "ACTIVE",
         "ownerOnlyEdit" : false,
         "maximumLength" : 100,
         "description" : "Indicates the name of the system who owns the record.",
         "fieldId" : "record_owner_name__v",
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "HCP" : "DEFAULT",
                  "PARENTHCO" : "DEFAULT",
                  "LICENSE" : "DEFAULT",
                  "CONTACT" : "DEFAULT",
                  "HCO" : "DEFAULT",
                  "ADDRESS" : "DEFAULT"
               }
            }
         },
         "fieldSet" : null,
         "readOnly" : true,
         "required" : false
      },
      {
         "status" : "ACTIVE",
         "ownerOnlyEdit" : false,
         "maximumLength" : 100,
         "description" : "Indicates whether the record is third party owned, OpenData owned or Customer Owned.",
         "fieldId" : "record_owner_type__v",
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "ADDRESS" : "DEFAULT",
                  "HCO" : "DEFAULT",
                  "CONTACT" : "DEFAULT",
                  "LICENSE" : "DEFAULT",
                  "PARENTHCO" : "DEFAULT",
                  "HCP" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldSet" : null,
         "readOnly" : true,
         "required" : false,
         "expression" : null,
         "type" : {
            "dataType" : "REFERENCE",
            "discriminator" : "RecordOwnerType"
         },
         "countries" : {
            "US" : {
               "expressionFlags" : 0,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "CUSTOMAFFILIATION",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "defaultValue" : null,
               "available" : true,
               "readOnly" : true,
               "required" : false,
               "expression" : null,
               "country" : "US"
            },
            "GB" : {
               "expression" : null,
               "country" : "GB",
               "expressionFlags" : 0,
               "available" : true,
               "defaultValue" : null,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "readOnly" : true,
               "required" : false
            }
         },
         "customerOwned" : false,
         "defaultValue" : null,
         "expressionFlags" : 0,
         "sinceVersion" : "17R2.0",
         "labels" : {
            "de" : "Typ des Datensatzeigentümers",
            "tr" : "Kayıt Sahibi Tipi",
            "en" : "Record Owner Type",
            "zh" : "记录所有者类型",
            "es" : "Tipo de propietario de registro",
            "pt-BR" : "Tipo do proprietário do registro",
            "zh_HK" : "記錄擁有者類型",
            "pt" : "Tipo de proprietário do registo",
            "it" : "Tipo di proprietario record",
            "fr" : "Type de propriétaire de l'enregistrement",
            "nl" : "Type recordeigenaar",
            "ja" : "レコード所有者タイプ"
         },
         "fieldGroup" : null,
         "dataPrivacyFlag" : "NONE",
         "blankAllowed" : true
      },
      {
         "expression" : null,
         "type" : {
            "discriminator" : "RecordState",
            "dataType" : "REFERENCE"
         },
         "customerOwned" : false,
         "countries" : {
            "US" : {
               "country" : "US",
               "expression" : null,
               "readOnly" : true,
               "required" : false,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "CUSTOMAFFILIATION",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "defaultValue" : "VALID",
               "available" : true,
               "expressionFlags" : 0
            },
            "GB" : {
               "readOnly" : true,
               "required" : false,
               "expressionFlags" : 0,
               "available" : true,
               "defaultValue" : "VALID",
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "country" : "GB",
               "expression" : null
            }
         },
         "defaultValue" : "VALID",
         "sinceVersion" : "1.0.0",
         "labels" : {
            "pt" : "Estado de registo",
            "es" : "Estado de registro",
            "pt-BR" : "Estado do registro",
            "zh_HK" : "記錄狀態",
            "zh" : "记录状态",
            "de" : "Datensatzstatus",
            "tr" : "Kayıt Durumu",
            "en" : "Record State",
            "ja" : "レコード状態",
            "fr" : "État de l'enregistrement",
            "nl" : "Recordstatus",
            "it" : "Stato del record"
         },
         "expressionFlags" : 0,
         "fieldGroup" : null,
         "blankAllowed" : true,
         "dataPrivacyFlag" : "NONE",
         "status" : "ACTIVE",
         "ownerOnlyEdit" : false,
         "maximumLength" : 20,
         "description" : "Internal Network record state",
         "fieldId" : "record_state__v",
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "HCO" : "DEFAULT",
                  "ADDRESS" : "DEFAULT",
                  "LICENSE" : "DEFAULT",
                  "PARENTHCO" : "DEFAULT",
                  "HCP" : "DEFAULT"
               }
            }
         },
         "fieldSet" : null,
         "readOnly" : true,
         "required" : false
      },
      {
         "status" : "ACTIVE",
         "maximumLength" : 100,
         "ownerOnlyEdit" : false,
         "description" : "These rules are the same as License Eligibility (see that field) but exclude the expiry date.",
         "fieldSet" : null,
         "required" : false,
         "readOnly" : false,
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            }
         },
         "fieldId" : "rxa_eligible__v",
         "type" : {
            "discriminator" : "LicenseEligibility",
            "dataType" : "REFERENCE"
         },
         "expression" : null,
         "countries" : {
            "GB" : {
               "expression" : null,
               "country" : "GB",
               "defaultValue" : null,
               "available" : false,
               "allowedObjectTypes" : [],
               "expressionFlags" : 0,
               "readOnly" : false,
               "required" : false
            },
            "US" : {
               "readOnly" : true,
               "required" : false,
               "expressionFlags" : 0,
               "available" : true,
               "defaultValue" : null,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "country" : "US",
               "expression" : null
            }
         },
         "customerOwned" : false,
         "expressionFlags" : 0,
         "labels" : {
            "zh" : "样品适合性",
            "tr" : "Örnek Uygunluk",
            "en" : "Sample Eligibility",
            "de" : "Muster Anspruchsberechtigung",
            "pt" : "Elegibilidade da amostra",
            "es" : "Elegibilidad de muestra",
            "pt-BR" : "Qualificação da amostra",
            "nl" : "Gerechtigdheid monster",
            "fr" : "Éligibilité de l'échantillon",
            "it" : "Idoneità di esempio",
            "ja" : "サンプル適格性"
         },
         "sinceVersion" : "4.0.0",
         "defaultValue" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true,
         "fieldGroup" : null
      },
      {
         "maximumLength" : 200,
         "ownerOnlyEdit" : false,
         "status" : "DEACTIVATED",
         "fieldSet" : null,
         "required" : false,
         "readOnly" : false,
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldId" : "source_address__v",
         "description" : "Address from license source",
         "countries" : {
            "GB" : {
               "country" : "GB",
               "expression" : null,
               "readOnly" : false,
               "required" : false,
               "available" : false,
               "defaultValue" : null,
               "allowedObjectTypes" : [],
               "expressionFlags" : 0
            },
            "US" : {
               "required" : false,
               "readOnly" : false,
               "expressionFlags" : 0,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "available" : true,
               "defaultValue" : null,
               "country" : "US",
               "expression" : null
            }
         },
         "customerOwned" : false,
         "type" : {
            "discriminator" : null,
            "dataType" : "STRING"
         },
         "expression" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true,
         "fieldGroup" : null,
         "expressionFlags" : 0,
         "sinceVersion" : "17R2.0",
         "labels" : {
            "zh" : "来自许可证来源的地址",
            "tr" : "Lisans Kaynağından Adres",
            "en" : "Address from License Source",
            "de" : "Adresse von Lizenzquelle",
            "pt" : "Endereço da origem da licença",
            "pt-BR" : "Endereço da licença de origem",
            "es" : "Dirección de fuente de licencia",
            "zh_HK" : "執照來源地址",
            "it" : "Indirizzo da origine licenza",
            "nl" : "Adres uit licentiebron",
            "fr" : "Adresse de la source de licence",
            "ja" : "ライセンスソースからの住所"
         },
         "defaultValue" : null
      },
      {
         "blankAllowed" : true,
         "dataPrivacyFlag" : "NONE",
         "fieldGroup" : null,
         "labels" : {
            "it" : "Data modificata dello stato",
            "fr" : "Date de modification du statut",
            "nl" : "Datum status gewijzigd",
            "ja" : "ステータス変更日",
            "tr" : "Durum Değişiklik Tarihi",
            "en" : "Status Modified Date",
            "de" : "Datum der Statusänderung",
            "zh" : "状态修改日期",
            "es" : "Fecha de modificación de estado",
            "zh_HK" : "狀態修改日期",
            "pt-BR" : "Data de modificação do status",
            "pt" : "Data de modificação do estado"
         },
         "sinceVersion" : "1.0.0",
         "expressionFlags" : 0,
         "defaultValue" : null,
         "customerOwned" : false,
         "countries" : {
            "US" : {
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "CUSTOMAFFILIATION",
                  "CUSTOMKEY",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "expressionFlags" : 0,
               "readOnly" : true,
               "required" : false,
               "expression" : null,
               "country" : "US"
            },
            "GB" : {
               "expression" : null,
               "country" : "GB",
               "expressionFlags" : 0,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "CUSTOMKEY",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "defaultValue" : null,
               "available" : true,
               "readOnly" : true,
               "required" : false
            }
         },
         "type" : {
            "discriminator" : null,
            "dataType" : "DATETIME"
         },
         "expression" : null,
         "fieldSet" : null,
         "required" : false,
         "readOnly" : true,
         "fieldId" : "status_update_time__v",
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT",
                  "CUSTOMKEY" : "DEFAULT",
                  "CONTACT" : "DEFAULT",
                  "ADDRESS" : "DEFAULT",
                  "HCO" : "DEFAULT",
                  "HCP" : "DEFAULT",
                  "PARENTHCO" : "DEFAULT"
               }
            }
         },
         "description" : "Date the status of this record was last modified",
         "maximumLength" : 25,
         "ownerOnlyEdit" : false,
         "status" : "ACTIVE"
      },
      {
         "countries" : {
            "GB" : {
               "required" : false,
               "readOnly" : false,
               "allowedObjectTypes" : [],
               "defaultValue" : null,
               "available" : false,
               "expressionFlags" : 0,
               "country" : "GB",
               "expression" : null
            },
            "US" : {
               "expression" : null,
               "country" : "US",
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "expressionFlags" : 0,
               "readOnly" : true,
               "required" : false
            }
         },
         "customerOwned" : false,
         "type" : {
            "discriminator" : "LicenseType",
            "dataType" : "REFERENCE"
         },
         "expression" : null,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "blankAllowed" : true,
         "fieldGroup" : null,
         "expressionFlags" : 0,
         "sinceVersion" : "1.0.0",
         "labels" : {
            "pt-BR" : "Tipo de licença",
            "es" : "Tipo de licencia",
            "zh_HK" : "授權類型",
            "pt" : "Tipo de licença",
            "de" : "Lizenztyp",
            "tr" : "Lisans Tipi",
            "en" : "License Type",
            "zh" : "执照类型",
            "ja" : "ライセンスタイプ",
            "nl" : "Type vergunning",
            "fr" : "Type de licence",
            "it" : "Tipo licenza"
         },
         "defaultValue" : null,
         "maximumLength" : 100,
         "ownerOnlyEdit" : false,
         "status" : "ACTIVE",
         "required" : false,
         "fieldSet" : null,
         "readOnly" : false,
         "fieldId" : "type__v",
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "description" : "Scope of the license"
      },
      {
         "fieldGroup" : null,
         "blankAllowed" : true,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "defaultValue" : null,
         "labels" : {
            "pt-BR" : "Autoridade licenciadora",
            "es" : "Autoridad emisora de licencias",
            "pt" : "Autoridade de licenciamento",
            "tr" : "Lisans Yetkisi",
            "en" : "Licensing Authority",
            "de" : "Lizenzbehörde",
            "zh" : "许可授权",
            "ja" : "ライセンス許可機関",
            "fr" : "Autorité d'octroi de licences",
            "nl" : "Vergunningverlenende autoriteit",
            "it" : "Autorità di licenza"
         },
         "sinceVersion" : "1.0.0",
         "expressionFlags" : 0,
         "customerOwned" : false,
         "countries" : {
            "US" : {
               "expression" : null,
               "country" : "US",
               "expressionFlags" : 0,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "LICENSE"
               ],
               "required" : false,
               "readOnly" : true
            },
            "GB" : {
               "country" : "GB",
               "expression" : null,
               "required" : false,
               "readOnly" : false,
               "allowedObjectTypes" : [],
               "defaultValue" : null,
               "available" : false,
               "expressionFlags" : 0
            }
         },
         "expression" : null,
         "type" : {
            "discriminator" : null,
            "dataType" : "STRING"
         },
         "changeProcedure" : {
            "regionalChangeProcedures" : {},
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "LICENSE" : "DEFAULT"
               }
            }
         },
         "fieldId" : "type_value__v",
         "required" : false,
         "fieldSet" : null,
         "readOnly" : false,
         "description" : "Geographic details regarding the scope of the license",
         "ownerOnlyEdit" : false,
         "maximumLength" : 20,
         "status" : "ACTIVE"
      },
      {
         "fieldGroup" : null,
         "blankAllowed" : true,
         "dataPrivacyFlag" : "NONE",
         "defaultValue" : null,
         "sinceVersion" : "1.0.0",
         "labels" : {
            "ja" : "Network エンティティ ID",
            "fr" : "ID d'entité Network",
            "nl" : "Network-entiteits-ID",
            "it" : "ID Network",
            "es" : "Network ID",
            "zh_HK" : "Network 實體識別碼",
            "pt-BR" : "ID de entidade do Network",
            "pt" : "ID de entidade do Network",
            "tr" : "Network Entity ID",
            "de" : "Netzwerk-Entitäts-ID",
            "en" : "Network Entity ID",
            "zh" : "Network 实体 ID"
         },
         "expressionFlags" : 0,
         "customerOwned" : false,
         "countries" : {
            "GB" : {
               "readOnly" : true,
               "required" : false,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "CUSTOMKEY",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "defaultValue" : null,
               "available" : true,
               "expressionFlags" : 0,
               "country" : "GB",
               "expression" : null
            },
            "US" : {
               "country" : "US",
               "expression" : null,
               "readOnly" : true,
               "required" : false,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "CUSTOMAFFILIATION",
                  "CUSTOMKEY",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "available" : true,
               "defaultValue" : null,
               "expressionFlags" : 0
            }
         },
         "expression" : null,
         "type" : {
            "dataType" : "VEEVAID",
            "discriminator" : null
         },
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "PARENTHCO" : "DEFAULT",
                  "HCP" : "DEFAULT",
                  "HCO" : "DEFAULT",
                  "ADDRESS" : "DEFAULT",
                  "CUSTOMKEY" : "DEFAULT",
                  "LICENSE" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldId" : "vid__v",
         "fieldSet" : null,
         "required" : false,
         "readOnly" : true,
         "description" : "Unique Network ID number",
         "ownerOnlyEdit" : false,
         "maximumLength" : 18,
         "status" : "ACTIVE"
      },
      {
         "description" : "",
         "readOnly" : false,
         "fieldSet" : null,
         "required" : false,
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "HCP" : "DEFAULT",
                  "LICENSE" : "DEFAULT",
                  "PARENTHCO" : "DEFAULT",
                  "HCO" : "DEFAULT",
                  "ADDRESS" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "fieldId" : "zz_test__c",
         "status" : "ACTIVE",
         "maximumLength" : null,
         "ownerOnlyEdit" : false,
         "expressionFlags" : 0,
         "labels" : {
            "en" : "ZZ TEST"
         },
         "sinceVersion" : null,
         "defaultValue" : null,
         "dataPrivacyFlag" : "NONE",
         "blankAllowed" : true,
         "fieldGroup" : null,
         "type" : {
            "dataType" : "STRING",
            "discriminator" : null
         },
         "expression" : null,
         "countries" : {
            "US" : {
               "country" : "US",
               "expression" : null,
               "required" : false,
               "readOnly" : false,
               "expressionFlags" : 0,
               "allowedObjectTypes" : [
                  "ADDRESS",
                  "HCO",
                  "HCP",
                  "LICENSE",
                  "PARENTHCO"
               ],
               "defaultValue" : null,
               "available" : true
            },
            "GB" : {
               "expression" : null,
               "country" : "GB",
               "expressionFlags" : 0,
               "allowedObjectTypes" : [],
               "available" : false,
               "defaultValue" : null,
               "required" : false,
               "readOnly" : false
            }
         },
         "customerOwned" : true
      }
   ],
   "responseStatus" : "SUCCESS"
}

This API enables you to retrieve detailed or summary information about the fields on each entity in Network.

Endpoint URL

https://{DNS}/api/{version}/metadata/fields

Optional parameters
objectTypes Filter fields to those applicable for certain object types:
  • Default - do not filter by object type.
  • Values - comma-separated list of object types from: HCP, HCO, LICENSE, ADDRESS, PARENTHCO, CUSTOMKEY
owner Filter fields to those owned by the specified party:
  • Default - do not filter by owner
  • Values - veeva (maintained by Veeva), customer (created and managed by the customer)
details Include field details:
  • Default - Only returns field IDs
  • Value - “full” (include field details in the results)
labels Include labels in field details:
  • Default - Include labels
  • Values - True or empty (include labels in the field details in the results)
fieldGroup Filter fields to those applicable for a certain field group:
  • Default - do not filter by field group
  • Values - The desired field group, for example, credentials, medical_degree, and so on
country Filter fields by country visibility:
  • Default - do not filter by country
  • Values - The desired country value, for example, US, GB, FR. The country must be visible to the authenticated user.
countries Filter fields by country visibility:
  • Default - do not filter by country
  • Values - The desired country values, for example, US, GB, FR. The countries must be visible to the authenticated user.
Response
responseStatus The status of the response from Network.
attributes An array attribute of information objects:
  • field_id - The ID of the field; for example, first_name__v.
  • type:
    • dataType - The type object, containing two attributes:
      • VEEVAID - an ID used in the Network system
      • STRING - text
      • YEAR - year value (no month or day)
      • DATE - date (no time)
      • DATETIME - date + Time (timestamp)
      • NUMBER - integer number
      • DOUBLE - floating point number
      • BOOLEAN - True or False value
      • REFERENCE - reference code
      • SET - a collection of values
    • discriminator - For reference data type, include the reference data type name
labels Set of language to description pairs (unless labels is not equal to True or empty).
customerOwned True if this is a custom field, False otherwise.
description Non-localized text description of field.
readOnly True if this is a read-only attribute, False otherwise.
ownerOnlyEdit True if this attribute can only be edited when owned by the customer. Cannot modify these attributes in Veeva OpenData records.
status One of ACTIVE, DELETED, or DEACTIVATED.
fieldGroup Either null or the name of the group for this attribute.
fieldSet Either null or the name of the field set for this attribute.
sinceVersion The Network version of when the attribute was released, for example, 1.0.0 or 1.5.2.
maximumLength The recommended maximum length for this attribute.
required True if this is a required attribute, False otherwise.
blankAllowed True if this attribute can be blank, False otherwise.
defaultValue The default value of this attribute.
expression NEX (Network Expression) rule that is evaluated to determine the value of this attribute
expressionFlags Bitwise OR of flags that describe when the expression is evaluated (1=evaluate on any value change, 2=evaluate on any attribute value change, 4=evaluate only if current value is not set)
dataPrivacyFlag The value that will be included in fields when the HCP record is marked as opted out. Current values:
  • NONE - No data privacy is applied to the field.
  • MASK_WITH_BLANK - The field value is replaced with a blank or null.
  • MASK_WITH_LABEL - The field value is replaced with a localized label: Data Privacy/Client Data Privacy
countries The country code. Current values:
  • available - a True/False value that indicates whether the field is available for a particular country
  • required - a True/False value that indicates whether the field is required when creating a new record for a particular country
  • readOnly - a True/False value that indicates whether the field is read-only for a particular country
  • defaultValue - a True/False value that indicates the default value if NULL is provided when creating a new record for a particular country
  • expression - NEX (Network Expression) rule that is evaluated to determine the value of this attribute
  • expressionFlags - bitwise OR of flags that describe when the expression is evaluated (1=evaluate on any value change, 2=evaluate on any attribute value change, 4=evaluate only if current value is not set)
  • allowedObjectTypes - an array of allowed types (from HCP, HCO, ADDRESS, LICENSE, PARENTHCO, CUSTOMKEY) for a particular country
changeProcedure This field replaces the deprecated changeRequest flag. This value can be configured per region and entity. For each of defaultChangeProcedure (default change procedure for the attribute) and regionalChangeProcedures (change procedures per region), the current values are as follows:
  • DEFAULT - let the system decide what to do
  • ALWAYS_ACCEPT_CHANGE - any changes will be automatically accepted without data steward review
  • ALWAYS_REVIEW - any changes to this field must be reviewed by a data steward

Notes

Changelog

Version 3.0 response includes required, blankAllowed, defaultValue, country.

Version 4.0 inclues the countries parameter.

Version 5.0 response includes expression and expressionFlags for attributes and countries.

Version 6.0 response includes the data privacy flag for attributes.

Retrieve field details metadata

Sample request

curl -X GET -H "Authorization: 57696C6C205261...6368204C6F7368" 'https://my.veevanetwork.com/api/v21.0/metadata/fields/academic_title__v'

Sample response

{
   "attributes" : [
      {
         "customerOwned" : false,
         "sinceVersion" : "1.0.0",
         "required" : false,
         "changeProcedure" : {
            "defaultChangeProcedure" : {
               "changeRequestFlags" : {
                  "HCP" : "DEFAULT"
               }
            },
            "regionalChangeProcedures" : {}
         },
         "maximumLength" : 100,
         "labels" : {
            "zh" : "学术职务",
            "es" : "Título académico",
            "pt-BR" : "Título acadêmico",
            "tr" : "Akademik Ünvan",
            "fr" : "Titre de formation",
            "zh_HK" : "學術職務",
            "en" : "Academic Title",
            "pt" : "Título académico",
            "nl" : "Academische titel",
            "de" : "Akademischer Titel",
            "it" : "Titolo accademico",
            "ja" : "大学職位"
         },
         "expressionFlags" : 0,
         "fieldId" : "academic_title__v",
         "ownerOnlyEdit" : false,
         "fieldGroup" : null,
         "countries" : {
            "AU" : {
               "required" : false,
               "expression" : null,
               "country" : "AU",
               "allowedObjectTypes" : [],
               "available" : false,
               "defaultValue" : null,
               "expressionFlags" : 0,
               "readOnly" : false
            },
            "IE" : {
               "country" : "IE",
               "required" : false,
               "expression" : null,
               "readOnly" : false,
               "expressionFlags" : 0,
               "allowedObjectTypes" : [],
               "defaultValue" : null,
               "available" : false
            },
            "NZ" : {
               "allowedObjectTypes" : [],
               "available" : false,
               "defaultValue" : null,
               "expressionFlags" : 0,
               "readOnly" : false,
               "expression" : null,
               "required" : false,
               "country" : "NZ"
            },
            "FR" : {
               "available" : false,
               "defaultValue" : null,
               "allowedObjectTypes" : [],
               "expressionFlags" : 0,
               "readOnly" : false,
               "required" : false,
               "expression" : null,
               "country" : "FR"
            },
            "BR" : {
               "expressionFlags" : 0,
               "readOnly" : false,
               "available" : true,
               "defaultValue" : null,
               "allowedObjectTypes" : [
                  "HCP"
               ],
               "country" : "BR",
               "required" : false,
               "expression" : null
            },
            "JP" : {
               "expressionFlags" : 0,
               "readOnly" : false,
               "allowedObjectTypes" : [],
               "available" : false,
               "defaultValue" : null,
               "country" : "JP",
               "expression" : null,
               "required" : false
            },
            "CN" : {
               "country" : "CN",
               "expression" : null,
               "required" : false,
               "readOnly" : false,
               "expressionFlags" : 0,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "HCP"
               ]
            },
            "DE" : {
               "readOnly" : false,
               "expressionFlags" : 0,
               "defaultValue" : null,
               "available" : true,
               "allowedObjectTypes" : [
                  "HCP"
               ],
               "country" : "DE",
               "required" : false,
               "expression" : null
            },
            "GB" : {
               "expressionFlags" : 0,
               "readOnly" : false,
               "allowedObjectTypes" : [],
               "available" : false,
               "defaultValue" : null,
               "country" : "GB",
               "expression" : null,
               "required" : false
            },
            "IT" : {
               "country" : "IT",
               "expression" : null,
               "required" : false,
               "expressionFlags" : 0,
               "readOnly" : false,
               "available" : false,
               "defaultValue" : null,
               "allowedObjectTypes" : []
            },
            "US" : {
               "allowedObjectTypes" : [],
               "available" : false,
               "defaultValue" : null,
               "expressionFlags" : 0,
               "readOnly" : false,
               "required" : false,
               "expression" : null,
               "country" : "US"
            }
         },
         "expression" : null,
         "blankAllowed" : true,
         "dataPrivacyFlag" : "MASK_WITH_BLANK",
         "defaultValue" : null,
         "type" : {
            "discriminator" : "HCPAcademicTitle",
            "dataType" : "REFERENCE"
         },
         "description" : "Academic Title",
         "fieldSet" : null,
         "readOnly" : false,
         "status" : "ACTIVE"
      }
   ],
   "responseStatus" : "SUCCESS"
}

This API enables you to retrieve detailed information about the fields on each entity in Network.

Endpoint URL

https://{DNS}/api/{version}/metadata/fields/{field_ids}

Optional parameters
labels Include labels in field details:
  • Default - Include labels
  • Values - True or empty (include labels in the field details in the results)
countries Filter fields by country visibility:
  • Default - do not filter by country
  • Values - The desired country values, for example, US, GB, FR. The countries must be visible to the authenticated user.
</
Response
responseStatus The status of the response from Network.
attributes An array attribute of information objects:
  • field_id - The ID of the field; for example, first_name__v.
  • type:
    • dataType - The type object, containing two attributes:
      • VEEVAID - an ID used in the Network system
      • STRING - text
      • YEAR - year value (no month or day)
      • DATE - date (no time)
      • DATETIME - date + Time (timestamp)
      • NUMBER - integer number
      • DOUBLE - floating point number
      • BOOLEAN - True or False value
      • REFERENCE - reference code
      • SET - a collection of values
    • discriminator - For reference data type, include the reference data type name
labels Set of language to description pairs (unless labels is not equal to True or empty).
customerOwned True if this is a custom field, False otherwise.
description Non-localized text description of field.
readOnly True if this is a read-only attribute, False otherwise.
ownerOnlyEdit True if this attribute can only be edited when owned by the customer. Cannot modify these attributes in Veeva OpenData records.
status One of ACTIVE, DELETED, or DEACTIVATED.
fieldGroup Either null or the name of the group for this attribute.
fieldSet Either null or the name of the field set for this attribute.
sinceVersion The Network version of when the attribute was released, for example, 1.0.0 or 1.5.2.
maximumLength The recommended maximum length for this attribute.
required True if this is a required attribute, False otherwise.
blankAllowed True if this attribute can be blank, False otherwise.
defaultValue The default value of this attribute.
expression NEX (Network Expression) rule that is evaluated to determine the value of this attribute
expressionFlags Bitwise OR of flags that describe when the expression is evaluated (1=evaluate on any value change, 2=evaluate on any attribute value change, 4=evaluate only if current value is not set)
dataPrivacyFlag The value that will be included in fields when the HCP record is marked as opted out. Current values:
  • NONE - No data privacy is applied to the field.
  • MASK_WITH_BLANK - The field value is replaced with a blank or null.
  • MASK_WITH_LABEL - The field value is replaced with a localized label: Data Privacy/Client Data Privacy