API Reference (1.0)

Copy

• Copy for LLM

  Copy page as Markdown for LLMs
• View as Markdown

  Open this page as Markdown
• Open in ChatGPT

  Get insights from ChatGPT
• Open in Claude

  Get insights from Claude

curl -i -X PUT \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/ACTIVITY_COLLECTOR \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "FtpDataSource": 0,
      "ActivityCollectorName": "string",
      "AccountId": "string",
      "Username": "string",
      "Delimiter": "string",
      "Created": "string",
      "FieldIncludedChar": "string",
      "FtpDirectory": "string",
      "FtpFilePattern": "string",
      "Status": "string",
      "Hostname": "string",
      "FtpLocationType": "string",
      "Type": "string",
      "TimeZoneId": 0,
      "RecordFormat": "string",
      "Sproc": "string",
      "AfterProcessDirectory": "string",
      "PrecollectorValidation": "string",
      "SkipRows": "string",
      "RunIntervalMin": "string",
      "LastRuntime": "string",
      "RateActivityFlag": "string",
      "LastRowId": "string",
      "Entity_Id": "string",
      "EntityMethod": "string",
      "StartDate": "string",
      "Updated": "string",
      "ExternalEntityFieldId": "string",
      "RetrieveSql": "string",
      "LastRowIdChar": "string",
      "ServicePointTypeId": "string",
      "LoadOrder": "string",
      "CreatedUserId": "string",
      "UpdatedUserId": "string",
      "Id": "string",
      "LookbackTimePeriodStart": "string",
      "LookbackTimePeriodEnd": "string",
      "AfterProcessFilePattern": "string",
      "HostPort": "string",
      "OmitEnd": "string",
      "ConsolidationMode": "string",
      "CreateAfterProcessDirectoryFlag": 0,
      "AfterProcessAction": "string",
      "BillableActivityFlag": "string",
      "DataSourceId": 0,
      "DataSourceFolder": "string",
      "RejectClosedFlag": 0
    }
  }'

curl -i -X PATCH \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/ACTIVITY_COLLECTOR \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "FtpDataSource": 0,
      "ActivityCollectorName": "string",
      "AccountId": "string",
      "Username": "string",
      "Delimiter": "string",
      "Created": "string",
      "FieldIncludedChar": "string",
      "FtpDirectory": "string",
      "FtpFilePattern": "string",
      "Status": "string",
      "Hostname": "string",
      "FtpLocationType": "string",
      "Type": "string",
      "TimeZoneId": 0,
      "RecordFormat": "string",
      "Sproc": "string",
      "AfterProcessDirectory": "string",
      "PrecollectorValidation": "string",
      "SkipRows": "string",
      "RunIntervalMin": "string",
      "LastRuntime": "string",
      "RateActivityFlag": "string",
      "LastRowId": "string",
      "Entity_Id": "string",
      "EntityMethod": "string",
      "StartDate": "string",
      "Updated": "string",
      "ExternalEntityFieldId": "string",
      "RetrieveSql": "string",
      "LastRowIdChar": "string",
      "ServicePointTypeId": "string",
      "LoadOrder": "string",
      "CreatedUserId": "string",
      "UpdatedUserId": "string",
      "Id": "string",
      "LookbackTimePeriodStart": "string",
      "LookbackTimePeriodEnd": "string",
      "AfterProcessFilePattern": "string",
      "HostPort": "string",
      "OmitEnd": "string",
      "ConsolidationMode": "string",
      "CreateAfterProcessDirectoryFlag": 0,
      "AfterProcessAction": "string",
      "BillableActivityFlag": "string",
      "DataSourceId": 0,
      "DataSourceFolder": "string",
      "RejectClosedFlag": 0
    },
    "externalIDFieldName": "ActivityCollectorName"
  }'

curl -i -X DELETE \
  https://bp-api-docs-v3.redocly.app/_mock/demogm_08_01_2025_schema/rest/2.0/delete/ACTIVITY_COLLECTOR \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'Content-Type: application/json; charset=utf-8' \
  -H 'sessionId: string' \
  -d '{
    "brmObjects": {
      "Id": "string"
    }
  }'