Robohead API Documentation - Campaign

REST API Documentation - Campaign Module

 EP : Extended Permissions

 +  : Consider the permission with + and all permissions above it.
       Permission hierarchy : Account Admin > Project Manager > Project Member > Contact
       Object (Campaign) security hierarchy : Manage > Contribute > View

Following is the campaign json structure required for add and update campaign. There are 3 arrays standardFields, customFields, deletedFields. If standard field is to be added put its details under standardFields array, with its field Id and value. If customFields is to be added put its details under customFields array, with its field Id and value. If value of any custom field is to be removed, put its Id and old value in the deletedFields array.

If field type is single select, multi select, radio or check box, pass Option Id as value. Applicable for both standard and custom fields.If multi select or check box, then specify different objects for each option.One example given in standard fields array for multi select field - 87327 which has two option Ids 66900, 66902

Following is the json structure with example :

     {"standardFields":
       [
         {"id":Provide field Id,
         "value":Provide value for that standard field },
         {"id":1384,"value":"camp descripion"},
         {"id":1386,"value":"08/04/2016"},
         {"id":87326,"value":66898},
         {"id":87327,"value":66900},
         {"id":87327,"value":66902}
       ],
       "customFields":
       [
         {"id":Provide field Id,
         "value":Provide value for that custom field},
         {"id":89900,"value":"abc@xyz.com"}
       ],
       "deletedFields":
       [
         {"id":Provide field Id,
         "deletedValue":Provide old value to delete}
       ]
     }

Following are filter details to be used for Campaign list calls. If applying filter on standard field pass the standard field Id in parameter standardFieldId. If applying filter on custom field pass the custom field Id in parameter columnId. Then provide what type of filter is to be applied like 'is' or 'is not' or 'not in' etc. This value is to be passed in the comparatorId parameter. Pass filter value in parameter 'value'. If filter value is of option type, then pass comma separated option Ids. Every column has a type. Hence pass this type in the parameter columnType.

Parameters comparatorId, value, columnType are required parameters. Depending on the column to which the filter is to be applied pass standardFieldId or columnId. Any one of these Ids is required to be passed.

To get list of columns, give call to ListListColumns of Account module. Pass account Id and form type 3 (ie Campaign form) to the call. The response contains list of ListColumn object. The ListColumn object contains Field object which will give the field details. The Field object contains the GlobalList object.

The 'displayName' field gives the name of the column.

If the global list Id is not null, the field is a standard field and if global list Id is null, the field is a custom field. If filter is to be applied on standard field then pass that field's global list Id to 'standardFieldId' parameter. If filter is to be applied on custom field pass the field Id to 'columnId' parameter.

The Field object contains 'fieldType' ie what type of field it is, like text, number, date, etc. Pass this fieldType to the 'columnType' parameter. Depending on type of field pass its value.

  standardFieldId : Provide field Id of the standard column on which filter is to be applied.
  columnId        : Provide field Id of the custom column on which filter is to be applied.
  comparatorId    : Comaparators that can be used for the column.
                    Give call to ListFieldComparator of Form module to get list of comparators.
                    Provide column type as fieldTypeId to the call.
                    It will return list of comparators that can be use for the field. Then provide the comparator to be applied on the filter.
  value           : Value to be provided for the filter.
  columnType      : Type of column.

  Following are the types of columns and their Ids and type of value to be passed for that filter :

   1 : text => Pass string value
   3 : number => Pass integer value
   4 : date => Pass date value
   7 : single select => If field is of type single select then its an option field. In this case pass the option Id. Different calls are to be given to get the options for the field. Their details are given in next para.
   9 : multi select => If field is of type multi select then its an option field. In this case pass the option Id. Different calls are to be given to get the options for the field. Their details are given in next para.

Following are the single select, multi select fields and call to be given to get their option list : 

       standardFieldColumnName : isBlocked (Campaign blocked)
           value: Provide Id (Give active options call to get options - ListActiveOptions of form module)
       standardFieldColumnName : onBudget (Campaign on budget)
           value: Provide Id (Give active options call to get options - ListActiveOptions of form module)
       standardFieldColumnName : isOnSchedule (Campaign on schedule)
           value: Provide Id (Give active options call to get options - ListActiveOptions of form module)
       standardFieldColumnName : clientName (Client)
           value: Provide comma separated ids (Give call to get active client list - ListAllActiveClient of client module)
       standardFieldColumnName : createdByUser (Created by)
           value: Provide comma separated Ids (Give call to get active account user list - ListActiveUser)
       standardFieldColumnName : modifiedByUser (Modified by)
           value: Provide comma separated Ids (Give call to get active account user list - ListActiveUser)

Following is the list of output columns for List campaign calls.

     name
     startDate
     createdOn
     createdByUser
     clientName
     modifiedByUser
     modifiedOn
     description
     isBlocked
     budgetedExpense
     projectTotalBudgetedCost
     projectBudgetedExpense
     budgetRemaining
     projectTotalActualCost
     projectEstimatedRevenue
     projectActualExpense
     isOnSchedule
     projectActualRevenue
     budgetedRevenue
     dueDate
     onBudget
     numProjectsOverBudget
     numTasksCompleted
     numTasksInProgress
     numTasksNotStarted
     totalActualTime
     totalEstimatedTime
     numProjects
     numProjectsBlocked

Paths List all operations