NAV
Ruby Shell

Attribution API v1

Attribution is a relation between a provider and a person, which indicates that the provider is responsible for the person’s health outcomes.

The Oracle Health Data Intelligence Attribution API enables the configuration of available attribution algorithms for a given population based on the requirements. See Attribution Algorithm Overview in the Reference Pages on Cerner Wiki for more information.

Note: The data retrieved by this API is filtered based on your sensitive data filters for Health Data Intelligence. Ensure that your implementations of this API are designed with this in mind, and if you integrate data from Health Data Intelligence into a clinical workflow using this API, ensure that your users are informed of your sensitive data filters. See Understand Sensitive Data in Oracle Health Data Intelligence in the Reference Pages on Cerner Wiki for more information.

URL: https://cernerdemo.api.us-1.healtheintent.com/attribution/v1

Configurations

The attribution configuration specifies the attribution algorithm and its corresponding custom settings to be used for processing a given client’s data.

Create a Configuration

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/configurations', headers: headers, body: {"name":"Attribution production configuration.","description":"This attribution configuration is for production.","population":{"id":"151d33be-cdc8-4637-89d4-c5c27b6f498d"},"algorithm":{"id":"fc36d5ee-955d-47ab-ae81-233756b07e3b","version":"1.0.0","name":"Cerner Standard attribution algorithm - Template 1","description":"This algorithm attributes the persons who have one of the following criteria:\n            Hard Attribution, Hard Attribution and Soft attribution.\n            Hard Attribution, Soft Attribution, Hard Attribution, and Soft attribution.\n            Hard Attribution, Hard Attribution, Soft Attribution, and Soft attribution.\n            Hard Attribution, Soft Attribution, Soft Attribution, and Hard attribution.","customSettings":[{"description":"Map of personnel by id of those personnel that are attributable.","key":"cernerdemo-attribution/attributable-personnel-by-id","settingValueType":"PERSONNEL_BY_ID","metadata":[{"dataSetType":"PERSONNEL_GROUP_MNEMONIC","referenceId":"attributable_personnel"}]}]}}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/configurations \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Attribution production configuration.","description":"This attribution configuration is for production.","population":{"id":"151d33be-cdc8-4637-89d4-c5c27b6f498d"},"algorithm":{"id":"fc36d5ee-955d-47ab-ae81-233756b07e3b","version":"1.0.0","name":"Cerner Standard attribution algorithm - Template 1","description":"This algorithm attributes the persons who have one of the following criteria:\n            Hard Attribution, Hard Attribution and Soft attribution.\n            Hard Attribution, Soft Attribution, Hard Attribution, and Soft attribution.\n            Hard Attribution, Hard Attribution, Soft Attribution, and Soft attribution.\n            Hard Attribution, Soft Attribution, Soft Attribution, and Hard attribution.","customSettings":[{"description":"Map of personnel by id of those personnel that are attributable.","key":"cernerdemo-attribution/attributable-personnel-by-id","settingValueType":"PERSONNEL_BY_ID","metadata":[{"dataSetType":"PERSONNEL_GROUP_MNEMONIC","referenceId":"attributable_personnel"}]}]}}

Example response

{
  "id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
  "version": "1",
  "name": "Attribution configuration For Client A - 2020",
  "description": "This attribution configuration is for production.",
  "population": {
    "id": "1424e81d-8cea-4d6b-b140-d6630c684a58"
  },
  "algorithm": {
    "id": "fc36d5ee-955d-47ab-ae81-233756b07e3b",
    "version": "1.0.0",
    "name": "Cerner Standard attribution algorithm - Template 1",
    "description": "This algorithm attributes the persons who have one of the following criteria:\nHard Attribution, Hard Attribution and Soft attribution.\nHard Attribution, Soft Attribution, Hard Attribution, and Soft attribution.\nHard Attribution, Hard Attribution, Soft Attribution, and Soft attribution.\nHard Attribution, Soft Attribution, Soft Attribution, and Hard attribution.\n",
    "customSettings": [
      {
        "description": "Map of personnel by id of those personnel that are attributable.",
        "key": "cernerdemo-attribution/attributable-personnel-by-id",
        "settingValueType": "PERSONNEL_BY_ID",
        "metadata": [
          {
            "dataSetType": "PERSONNEL_GROUP_MNEMONIC",
            "referenceId": "attributable_personnel"
          }
        ]
      }
    ]
  },
  "createdAt": "2020-11-11T12:30:45Z",
  "updatedAt": "2020-11-11T12:30:45Z"
}

POST /configurations

Creates a new configuration for a client.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postConfigurations true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created A configuration object. AttributionPublicApi_Entities_V1_Configuration_Configuration
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a List of Configurations

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/configurations', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/configurations \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
      "version": "1",
      "name": "Attribution configuration For Client A - 2020",
      "description": "This attribution configuration is for production.",
      "population": {
        "id": "1424e81d-8cea-4d6b-b140-d6630c684a58"
      },
      "algorithm": {
        "id": "fc36d5ee-955d-47ab-ae81-233756b07e3b",
        "version": "1.0.0",
        "name": "Cerner Standard attribution algorithm - Template 1",
        "description": "This algorithm attributes the persons who have one of the following criteria:\nHard Attribution, Hard Attribution and Soft attribution.\nHard Attribution, Soft Attribution, Hard Attribution, and Soft attribution.\nHard Attribution, Hard Attribution, Soft Attribution, and Soft attribution.\nHard Attribution, Soft Attribution, Soft Attribution, and Hard attribution.\n",
        "customSettings": [
          {
            "description": "Map of personnel by id of those personnel that are attributable.",
            "key": "cernerdemo-attribution/attributable-personnel-by-id",
            "settingValueType": "PERSONNEL_BY_ID",
            "metadata": [
              {
                "dataSetType": "PERSONNEL_GROUP_MNEMONIC",
                "referenceId": "attributable_personnel"
              }
            ]
          }
        ]
      },
      "createdAt": "2020-11-11T12:30:45Z",
      "updatedAt": "2020-11-11T12:30:45Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/configurations?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/configurations?offset=0&limit=20"
}

GET /configurations

Retrieves a list of all configurations available for a given client when no parameters are passed. The most recently created version of the configuration is retrieved based on the population ID included in the query parameters.Note: For any population ID, more than one active configuration cannot exist.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId query string false N/A The unique ID of the population. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false name,updatedAt A comma-separated list of fields by which to sort. name, -name, updatedAt, -updatedAt

Response Statuses

Status Meaning Description Schema
200 OK A collection of configuration objects. Configurations
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Delete a Configuration

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /configurations/{configurationId}

Deletes an existing configuration.

Parameters

Parameter In Type Required Default Description Accepted Values
configurationId path string true N/A The unique ID of the configuration. -

Response Statuses

Status Meaning Description Schema
204 No Content No content (Delete successful) None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Configuration

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91', headers: headers, body: {"name":"Attribution production configuration.","description":"This attribution configuration is for production.","population":{"id":"151d33be-cdc8-4637-89d4-c5c27b6f498d"},"algorithm":{"id":"fc36d5ee-955d-47ab-ae81-233756b07e3b","version":"1.0.0","name":"Cerner Standard attribution algorithm - Template 1","description":"This algorithm attributes the persons who have one of the following criteria:\n            Hard Attribution, Hard Attribution and Soft attribution.\n            Hard Attribution, Soft Attribution, Hard Attribution, and Soft attribution.\n            Hard Attribution, Hard Attribution, Soft Attribution, and Soft attribution.\n            Hard Attribution, Soft Attribution, Soft Attribution, and Hard attribution.","customSettings":[{"description":"Map of personnel by id of those personnel that are attributable.","key":"cernerdemo-attribution/attributable-personnel-by-id","settingValueType":"PERSONNEL_BY_ID","metadata":[{"dataSetType":"PERSONNEL_GROUP_MNEMONIC","referenceId":"attributable_personnel"}]}]}}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/configurations/a426149a-c19c-413a-8d9f-d7988aec4a91 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"Attribution production configuration.","description":"This attribution configuration is for production.","population":{"id":"151d33be-cdc8-4637-89d4-c5c27b6f498d"},"algorithm":{"id":"fc36d5ee-955d-47ab-ae81-233756b07e3b","version":"1.0.0","name":"Cerner Standard attribution algorithm - Template 1","description":"This algorithm attributes the persons who have one of the following criteria:\n            Hard Attribution, Hard Attribution and Soft attribution.\n            Hard Attribution, Soft Attribution, Hard Attribution, and Soft attribution.\n            Hard Attribution, Hard Attribution, Soft Attribution, and Soft attribution.\n            Hard Attribution, Soft Attribution, Soft Attribution, and Hard attribution.","customSettings":[{"description":"Map of personnel by id of those personnel that are attributable.","key":"cernerdemo-attribution/attributable-personnel-by-id","settingValueType":"PERSONNEL_BY_ID","metadata":[{"dataSetType":"PERSONNEL_GROUP_MNEMONIC","referenceId":"attributable_personnel"}]}]}}

Example response

{
  "id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
  "version": "1",
  "name": "Attribution configuration For Client A - 2020",
  "description": "This attribution configuration is for production.",
  "population": {
    "id": "1424e81d-8cea-4d6b-b140-d6630c684a58"
  },
  "algorithm": {
    "id": "fc36d5ee-955d-47ab-ae81-233756b07e3b",
    "version": "1.0.0",
    "name": "Cerner Standard attribution algorithm - Template 1",
    "description": "This algorithm attributes the persons who have one of the following criteria:\nHard Attribution, Hard Attribution and Soft attribution.\nHard Attribution, Soft Attribution, Hard Attribution, and Soft attribution.\nHard Attribution, Hard Attribution, Soft Attribution, and Soft attribution.\nHard Attribution, Soft Attribution, Soft Attribution, and Hard attribution.\n",
    "customSettings": [
      {
        "description": "Map of personnel by id of those personnel that are attributable.",
        "key": "cernerdemo-attribution/attributable-personnel-by-id",
        "settingValueType": "PERSONNEL_BY_ID",
        "metadata": [
          {
            "dataSetType": "PERSONNEL_GROUP_MNEMONIC",
            "referenceId": "attributable_personnel"
          }
        ]
      }
    ]
  },
  "createdAt": "2020-11-11T12:30:45Z",
  "updatedAt": "2020-11-11T12:30:45Z"
}

PUT /configurations/{configurationId}

Updates an existing configuration for a client.

Parameters

Parameter In Type Required Default Description Accepted Values
configurationId path string true N/A The unique ID of the configuration. -
body body putConfigurations true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK A single configuration object. AttributionPublicApi_Entities_V1_Configuration_Configuration
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Algorithms

The attribution algorithm defines the algorithm to be used by the configurations. The algorithm is used to identify namespaces of the rules and the available settings.

Retrieve a List of Algorithms

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/algorithms', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/algorithms \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "fc36d5ee-955d-47ab-ae81-233756b07e3b",
      "version": "1.0.0",
      "name": "Cerner Standard attribution algorithm - Template 1",
      "description": "This algorithm attributes the persons who have one of the following criteria:\nHard Attribution, Hard Attribution and Soft attribution.\nHard Attribution, Soft Attribution, Hard Attribution, and Soft attribution.\nHard Attribution, Hard Attribution, Soft Attribution, and Soft attribution.\nHard Attribution, Soft Attribution, Soft Attribution, and Hard attribution.\n",
      "availableSettings": [
        {
          "name": "scoring-group-by-id",
          "required": true,
          "description": "Map of scoring group objects by id for all scoring groups.",
          "default": null,
          "processingConfiguration": {
            "key": "cernerdemo-attribution/scoring-group-by-id",
            "settingValueType": "PERSONNEL_GROUP_BY_ID"
          }
        },
        {
          "name": "ppr-type-concepts",
          "required": false,
          "description": "Concepts used to identify the primary care provider PPR for hard attribution. Any additional types should be provided using config.",
          "default": "[\"PRIMARY_CARE_PROVIDER_PRROLE\", \"ATTRIBUTED_PROVIDER_PRROLE\"]",
          "processingConfiguration": {
            "key": "cernerdemo-attribution/ppr-type-concepts",
            "settingValueType": "STRINGS"
          }
        },
        {
          "name": "visit-lookback-period",
          "required": false,
          "description": "Lookback period in months for visits.",
          "default": "24",
          "processingConfiguration": {
            "key": "cernerdemo-attribution/visit-lookback-period",
            "settingValueType": "STRING"
          }
        },
        {
          "name": "pcp-hard-look-back",
          "required": false,
          "description": "Number of days to look back for a ProviderRelationship.endDate",
          "default": "180",
          "processingConfiguration": {
            "key": "cernerdemo-attribution/pcp-hard-look-back",
            "settingValueType": "STRING"
          }
        },
        {
          "name": "gecb-partitions",
          "required": true,
          "description": "Setting for set of GECB data partitions.",
          "default": null,
          "processingConfiguration": {
            "key": "cernerdemo-attribution/gecb-partitions",
            "settingValueType": "DATA_PARTITION_IDS"
          }
        },
        {
          "name": "emr-data-partitions",
          "required": true,
          "description": "Setting for set of emr data partitions.",
          "default": null,
          "processingConfiguration": {
            "key": "cernerdemo-attribution/emr-data-partitions",
            "settingValueType": "DATA_PARTITION_IDS"
          }
        }
      ]
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/algorithms?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/algorithms?offset=0&limit=20"
}

GET /algorithms

Retrieves a list of algorithms available for a client.

Parameters

Parameter In Type Required Default Description Accepted Values
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false name,updatedAt A comma-separated list of fields by which to sort. name, -name, updatedAt, -updatedAt

Response Statuses

Status Meaning Description Schema
200 OK A collection of algorithm objects. Algorithms
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Pipelines

An Attribution Pipeline is an instance of a configurable data pipeline for running an Attribution Job. Attribution Entitlement would limit the number of Pipelines the tenant could run.

Create a Pipeline

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/pipelines', headers: headers, body: {"name":"name","population":{"id":"151d33be-cdc8-4637-89d4-c5c27b6f498d"},"state":"ACTIVE","executionSettings":{"frequencyValue":8,"frequencyUnit":"HOURS","timeOfDay":"00:00"},"properties":[{"key":"property key 1","value":"property detail 1"},{"key":"property key 2","value":"property detail 2"}],"job":{"id":"151d33be-cdc8-4637-89d4-c5c27b6f498d","version":2}}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/pipelines \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"name","population":{"id":"151d33be-cdc8-4637-89d4-c5c27b6f498d"},"state":"ACTIVE","executionSettings":{"frequencyValue":8,"frequencyUnit":"HOURS","timeOfDay":"00:00"},"properties":[{"key":"property key 1","value":"property detail 1"},{"key":"property key 2","value":"property detail 2"}],"job":{"id":"151d33be-cdc8-4637-89d4-c5c27b6f498d","version":2}}

Example response

{
  "id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
  "version": 2,
  "name": "Attribution Pipeline 1",
  "population": {
    "id": "1424e81d-8cea-4d6b-b140-d6630c684a58"
  },
  "state": "ACTIVE",
  "executionSettings": {
    "frequencyValue": 8,
    "frequencyUnit": "HOURS",
    "timeOfDay": "00:00"
  },
  "lastRunStatus": "COMPLETED",
  "lastSuccessfulRun": "2021-12-02T12:30:45Z",
  "properties": [
    {
      "key": "property key 1",
      "value": "property detail 1"
    },
    {
      "key": "property key 2",
      "value": "property detail 2"
    }
  ],
  "job": {
    "id": "151d33be-cdc8-4637-89d4-c5c27b6f498d",
    "version": 2
  },
  "tags": [
    {
      "key": "tag key 1",
      "value": "tag detail 1"
    },
    {
      "key": "tag key 2",
      "value": "tag detail 2"
    }
  ],
  "createdAt": "2020-11-11T12:30:45Z",
  "updatedAt": "2020-11-11T12:30:45Z"
}

POST /pipelines

Creates a new pipeline.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postPipelines true N/A No description -

Response Statuses

Status Meaning Description Schema

|201|Created|A pipeline object.|AttributionPublicApi_Entities_V1_Pipeline_Pipeline| |400|Bad Request|Bad Request|Error| |401|Unauthorized|Unauthorized|Error| |403|Forbidden|Forbidden|Error|

Retrieve a List of Pipelines

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/pipelines', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/pipelines \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
      "version": 2,
      "name": "Attribution Pipeline 1",
      "population": {
        "id": "1424e81d-8cea-4d6b-b140-d6630c684a58"
      },
      "state": "ACTIVE",
      "executionSettings": {
        "frequencyValue": 8,
        "frequencyUnit": "HOURS",
        "timeOfDay": "00:00"
      },
      "lastRunStatus": "COMPLETED",
      "lastSuccessfulRun": "2021-12-02T12:30:45Z",
      "properties": [
        {
          "key": "property key 1",
          "value": "property detail 1"
        },
        {
          "key": "property key 2",
          "value": "property detail 2"
        }
      ],
      "job": {
        "id": "151d33be-cdc8-4637-89d4-c5c27b6f498d",
        "version": 2
      },
      "tags": [
        {
          "key": "tag key 1",
          "value": "tag detail 1"
        },
        {
          "key": "tag key 2",
          "value": "tag detail 2"
        }
      ],
      "createdAt": "2020-11-11T12:30:45Z",
      "updatedAt": "2020-11-11T12:30:45Z"
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/pipelines?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/pipelines?offset=0&limit=20"
}

GET /pipelines

Retrieves a list of pipelines.

Parameters

Parameter In Type Required Default Description Accepted Values
populationId query string false N/A The unique ID of the population. -
tag query string false N/A Filters the response by the specified tags. Each tag can be represented as a single key or a key:value pair. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false name,updatedAt A comma-separated list of fields by which to sort. name, -name, updatedAt, -updatedAt

Response Statuses

Status Meaning Description Schema
200 OK A collection of pipeline objects. Pipelines
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Delete a Pipeline

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/pipelines/74ee2a39-2703-4796-9b5e-d103e537e999', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/pipelines/74ee2a39-2703-4796-9b5e-d103e537e999 \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /pipelines/{pipelineId}

Deletes a pipeline with the specified ID.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline. -

Response Statuses

Status Meaning Description Schema
204 No Content No content (Delete successful) None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Update a Pipeline

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.put('https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/pipelines/74ee2a39-2703-4796-9b5e-d103e537e999', headers: headers, body: {"name":"name","population":{"id":"151d33be-cdc8-4637-89d4-c5c27b6f498d"},"state":"ACTIVE","executionSettings":{"frequencyValue":8,"frequencyUnit":"HOURS","timeOfDay":"00:00"},"properties":[{"key":"property key 1","value":"property detail 1"},{"key":"property key 2","value":"property detail 2"}],"job":{"id":"151d33be-cdc8-4637-89d4-c5c27b6f498d","version":2}}.to_json )

print JSON.pretty_generate(result)





# You can also use wget
curl -X PUT https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/pipelines/74ee2a39-2703-4796-9b5e-d103e537e999 \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"name":"name","population":{"id":"151d33be-cdc8-4637-89d4-c5c27b6f498d"},"state":"ACTIVE","executionSettings":{"frequencyValue":8,"frequencyUnit":"HOURS","timeOfDay":"00:00"},"properties":[{"key":"property key 1","value":"property detail 1"},{"key":"property key 2","value":"property detail 2"}],"job":{"id":"151d33be-cdc8-4637-89d4-c5c27b6f498d","version":2}}

Example response

{
  "id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
  "version": 2,
  "name": "Attribution Pipeline 1",
  "population": {
    "id": "1424e81d-8cea-4d6b-b140-d6630c684a58"
  },
  "state": "ACTIVE",
  "executionSettings": {
    "frequencyValue": 8,
    "frequencyUnit": "HOURS",
    "timeOfDay": "00:00"
  },
  "lastRunStatus": "COMPLETED",
  "lastSuccessfulRun": "2021-12-02T12:30:45Z",
  "properties": [
    {
      "key": "property key 1",
      "value": "property detail 1"
    },
    {
      "key": "property key 2",
      "value": "property detail 2"
    }
  ],
  "job": {
    "id": "151d33be-cdc8-4637-89d4-c5c27b6f498d",
    "version": 2
  },
  "tags": [
    {
      "key": "tag key 1",
      "value": "tag detail 1"
    },
    {
      "key": "tag key 2",
      "value": "tag detail 2"
    }
  ],
  "createdAt": "2020-11-11T12:30:45Z",
  "updatedAt": "2020-11-11T12:30:45Z"
}

PUT /pipelines/{pipelineId}

Updates a pipeline with the specified ID.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline. -
body body putPipelines true N/A No description -

Response Statuses

Status Meaning Description Schema
200 OK The pipeline is successfully updated. AttributionPublicApi_Entities_V1_Pipeline_Pipeline
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a Pipeline

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/pipelines/{pipelineId}', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/pipelines/{pipelineId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
  "version": 2,
  "name": "Attribution Pipeline 1",
  "population": {
    "id": "1424e81d-8cea-4d6b-b140-d6630c684a58"
  },
  "state": "ACTIVE",
  "executionSettings": {
    "frequencyValue": 8,
    "frequencyUnit": "HOURS",
    "timeOfDay": "00:00"
  },
  "lastRunStatus": "COMPLETED",
  "lastSuccessfulRun": "2021-12-02T12:30:45Z",
  "properties": [
    {
      "key": "property key 1",
      "value": "property detail 1"
    },
    {
      "key": "property key 2",
      "value": "property detail 2"
    }
  ],
  "job": {
    "id": "151d33be-cdc8-4637-89d4-c5c27b6f498d",
    "version": 2
  },
  "tags": [
    {
      "key": "tag key 1",
      "value": "tag detail 1"
    },
    {
      "key": "tag key 2",
      "value": "tag detail 2"
    }
  ],
  "createdAt": "2020-11-11T12:30:45Z",
  "updatedAt": "2020-11-11T12:30:45Z"
}

GET /pipelines/{pipelineId}

Retrieves a pipeline with the specified ID.

Parameters

Parameter In Type Required Default Description Accepted Values
pipelineId path string true N/A The unique ID of the pipeline. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieves pipeline object successfully. AttributionPublicApi_Entities_V1_Pipeline_Pipeline
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Tags

Tags are used to assign metadata to the attribution pipeline or job resource. The metadata can be used to provide information on categorizing whether the resource is used for production or validation, or any arbitrary information related to tracking the issues contributing to the creation of the resource.

Create a Tag

Example Request:




require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Content-Type' => 'application/json',
  'Accept' => 'application/json'
} 

result = HTTParty.post('https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/tags', headers: headers, body: {"key":"Tag Key 1","value":"Tag Key Value 1","resource":{"id":"a426149a-c19c-413a-8d9f-d7988aec4a91","type":"PIPELINE"}}.to_json)
print JSON.pretty_generate(result)





# You can also use wget
curl -X POST https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/tags \
-H 'Authorization: {auth_header}' \
-H 'Content-Type: application/json' \ \
-H 'Accept: application/json' \
-d {"key":"Tag Key 1","value":"Tag Key Value 1","resource":{"id":"a426149a-c19c-413a-8d9f-d7988aec4a91","type":"PIPELINE"}}

Example response

{
  "id": "d1e7af18-713f-43db-806c-c8c8a77e5f89",
  "key": "Tag Key 1",
  "value": "Tag Key Value 1",
  "resource": {
    "id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
    "type": "PIPELINE"
  }
}

POST /tags

Creates a new tag for a pipleine or job.

Parameters

Parameter In Type Required Default Description Accepted Values
body body postTags true N/A No description -

Response Statuses

Status Meaning Description Schema
201 Created A tag object. AttributionPublicApi_Entities_V1_Tag_Tag
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Retrieve a List of Tags

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/tags', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/tags \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "items": [
    {
      "id": "d1e7af18-713f-43db-806c-c8c8a77e5f89",
      "key": "Tag Key 1",
      "value": "Tag Key Value 1",
      "resource": {
        "id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
        "type": "PIPELINE"
      }
    }
  ],
  "totalResults": 1,
  "firstLink": "https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/tags?offset=0&limit=20",
  "lastLink": "https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/tags?offset=0&limit=20"
}

GET /tags

Retrieves a list of tags.

Parameters

Parameter In Type Required Default Description Accepted Values
resourceType query string false N/A The resource type of the tag pipeline or job. -
offset query integer(int32) false 0 The number of results to skip from the beginning of the list of results (typically for the purpose of paging). The minimum offset is 0. There is no maximum offset. -
limit query integer(int32) false 20 The maximum number of results to display per page. The minimum limit is 1. The maximum limit is 100. -
orderBy query string false key A comma-separated list of fields by which to sort. key, -key

Response Statuses

Status Meaning Description Schema
200 OK A collection of tag objects. Tags
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Delete a Tag

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.delete('https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/tags/{tagId}', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X DELETE https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/tags/{tagId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

DELETE /tags/{tagId}

Deletes a tag with the specified ID.

Parameters

Parameter In Type Required Default Description Accepted Values
tagId path string true N/A The unique ID of the tag. -

Response Statuses

Status Meaning Description Schema
204 No Content No content (Delete successful) None
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error
404 Not Found Not Found Error

Retrieve a Tag

Example Request:


require 'httparty' # Using HTTParty 0.16.2
require 'json'

headers = {
  'Authorization' => '<auth_header>',
  'Accept' => 'application/json'
} 

result = HTTParty.get('https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/tags/{tagId}', headers: headers)

print JSON.pretty_generate(result)



# You can also use wget
curl -X GET https://cernerdemo.api.us-1.healtheintent.com/attribution/v1/tags/{tagId} \
-H 'Authorization: {auth_header}' \
-H 'Accept: application/json'

Example response

{
  "id": "d1e7af18-713f-43db-806c-c8c8a77e5f89",
  "key": "Tag Key 1",
  "value": "Tag Key Value 1",
  "resource": {
    "id": "a426149a-c19c-413a-8d9f-d7988aec4a91",
    "type": "PIPELINE"
  }
}

GET /tags/{tagId}

Retrieves a tag with the specified ID.

Parameters

Parameter In Type Required Default Description Accepted Values
tagId path string true N/A The unique ID of the tag. -

Response Statuses

Status Meaning Description Schema
200 OK Retrieves tag object successfully. AttributionPublicApi_Entities_V1_Tag_Tag
400 Bad Request Bad Request Error
401 Unauthorized Unauthorized Error
403 Forbidden Forbidden Error

Schema Definitions

postConfigurations

Name Type Required Description Accepted Values
name string true The unique name of the attribution configuration. -
description string true The description of the attribution configuration. -
population object true The unique ID of the population that identifies the longitudinal records used to process the attributions. -
» id string true The unique ID of the population. -
algorithm object true The algorithm that the provided configuration uses. -
» id string true The unique ID of the algorithm that is used by the configuration. -
» version string true The version of the algorithm used as part of the configuration. -
» name string true The name of the algorithm to use as part of the configuration. -
» description string false The description of the algorithm to use as part of the configuration. -
» customSettings [object] false The custom settings used by the algorithm during processing. These can have either configured values or metadata. -
»» description string false The description provided for the custom setting. -
»» key string true The unique key to identify the custom setting. -
»» settingValueType string false The type of the custom setting. -
»» metadata [object] false Metadata for the custom setting. -
»»» dataSetType string true The dataset type for the custom setting. -
»»» referenceId string true The reference ID used by the custom setting. -
»» value string false A single value for the custom setting. -
»» values [string] false The values used to initialize the custom setting. -

AttributionPublicApi_Entities_V1_Configuration_Configuration

Name Type Required Description Accepted Values
id string true The unique ID of the configuration. -
version integer(int32) true The version number of the configuration, which is incremented automatically. -
name string true The name of the configuration. -
description string true The description of the configuration. -
population AttributionPublicApi_Entities_V1_PopulationReference true The unique ID of the population that identifies the longitudinal records used to process the attributions. -
algorithm AttributionPublicApi_Entities_V1_Configuration_ConfigurationAlgorithm true The algorithm that the configuration uses. -
createdAt string true The date and time when the configuration was initially entered into the system. This value is provided in International Organization for Standardization (ISO) 8601 formatting with precision to YYYY-MM-DDThh:mm:ss.SSSZ, such as 2018-02-13T20:41:18.181Z. The time is set automatically when the configuration is first created. Therefore, the field does not need to be set explicitly. -
updatedAt string true The date and time when the configuration was updated in the system. This value is provided in ISO 8601 formatting with precision to YYYY-MM-DDThh:mm:ss.SSSZ, such as 2018-02-13T20:41:18.181Z. The time is set automatically when the configuration is updated. Therefore, the field does not need to be set explicitly. -

AttributionPublicApi_Entities_V1_PopulationReference

Name Type Required Description Accepted Values
id string true The unique ID of the population. -

AttributionPublicApi_Entities_V1_Configuration_ConfigurationAlgorithm

Name Type Required Description Accepted Values
id string true The unique ID of the algorithm. -
version string true The version of the algorithm to use as part of the configuration. -
name string true The name of the algorithm to use as part of the configuration. -
description string false The description of the algorithm to use as part of the configuration. -
customSettings [AttributionPublicApi_Entities_V1_Configuration_CustomSetting] true The custom settings the algorithm uses during processing. These can have either configured values or metadata. -

AttributionPublicApi_Entities_V1_Configuration_CustomSetting

Name Type Required Description Accepted Values
description string false The description provided for the custom setting. -
key string true The unique key to identify the custom setting. -
settingValueType string false The type of the custom setting. BENEFIT_PLANS_BY_SOURCE_ID, ORGANIZATION, ORGANIZATION_RECORDS, ORG_IDS_BY_ORG_CLASS, ORG_NAME_BY_ID, ORG_SERVICE_POSTAL_CODES_BY_ID, PERSONNEL_BY_ID, PERSONNEL_BY_ORG_ID, PERSONNEL_GROUP_BY_ID, PRSNL_ORG_COMMITMENT_BY_ORG_ID
metadata [AttributionPublicApi_Entities_V1_Configuration_Metadata] false Metadata for the custom setting. -
value string false A single value for the custom setting. -
values [string] false The values used to initialize the custom setting. -

AttributionPublicApi_Entities_V1_Configuration_Metadata

Name Type Required Description Accepted Values
dataSetType string true The dataset type of the custom setting. PERSONNEL_GROUP, PERSONNEL_GROUP_MNEMONIC, PERSONNEL_GROUPS, PERSONNEL_PCOLLECTION, PERSONNEL_GROUP_PCOLLECTION, ORG_CLASS, ORGANIZATION, BENEFIT_PLAN_REF, ORGANIZATION_RECORD_REF, SUBPOPULATION, ORGANIZATIONS, ORGANIZATION_PCOLLECTION, PROVIDER_PERSONNEL_ROLES_PCOLLECTION, PROVIDER_BRANCH_CONFIG_PCOLLECTION, PROVIDER_HIERARCHY_BRANCH_PCOLLECTION, PROVIDER_SPECIALTY_PCOLLECTION
referenceId string true The reference ID used by the custom setting. -

Error

Name Type Required Description Accepted Values
code integer(int32) true The HTTP response status code that represents the error. -
message string true A human-readable description of the error. -
errorDetails [ErrorDetail] false A list of additional error details. -

ErrorDetail

Name Type Required Description Accepted Values
domain string false A subsystem or context where an error occurred. -
reason string false A codified value that represents the specific error that caused the current error status. -
message string false A human-readable description of an error. -
locationType string false The location or type of the field that caused an error. query, header, path, formData, body
location string false The name of the field that caused an error. -

Configurations

Name Type Required Description Accepted Values
items [AttributionPublicApi_Entities_V1_Configuration_Configuration] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putConfigurations

Name Type Required Description Accepted Values
name string true The unique name of the attribution configuration. -
description string true The description of the attribution configuration. -
population object true The unique ID of the population that identifies the longitudinal records used to process the attributions. -
» id string true The unique ID of the population. -
algorithm object true The algorithm that the provided configuration uses. -
» id string true The unique ID of the algorithm that is used by the configuration. -
» version string true The version of the algorithm used as part of the configuration. -
» name string true The name of the algorithm to use as part of the configuration. -
» description string false The description of the algorithm to use as part of the configuration. -
» customSettings [object] false The custom settings used by the algorithm during processing. These can have either configured values or metadata. -
»» description string false The description provided for the custom setting. -
»» key string true The unique key to identify the custom setting. -
»» settingValueType string false The type of the custom setting. -
»» metadata [object] false Metadata for the custom setting. -
»»» dataSetType string true The dataset type for the custom setting. -
»»» referenceId string true The reference ID used by the custom setting. -
»» value string false A single value for the custom setting. -
»» values [string] false The values used to initialize the custom setting. -

Algorithms

Name Type Required Description Accepted Values
items [AttributionPublicApi_Entities_V1_Algorithm_Algorithm] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

AttributionPublicApi_Entities_V1_Algorithm_Algorithm

Name Type Required Description Accepted Values
id string true The unique ID of the algorithm. -
version string true The version of the algorithm. -
name string true The name of the algorithm. -
description string false The description of the configuration. -
availableSettings [AttributionPublicApi_Entities_V1_Algorithm_AvailableSetting] false The available settings for the given algorithm. -

AttributionPublicApi_Entities_V1_Algorithm_AvailableSetting

Name Type Required Description Accepted Values
name string true The name given to the available setting. -
required boolean true A Boolean value to denote whether the setting value must be manually defined. -
description string false The description provided for the available setting. -
default string false The default values for the available setting in string format. A null value indicates that no default value is assigned. -
processingConfiguration [AttributionPublicApi_Entities_V1_Algorithm_ProcessingConfiguration] true Processing configuration details for the available setting. -

AttributionPublicApi_Entities_V1_Algorithm_ProcessingConfiguration

Name Type Required Description Accepted Values
key string true The key used to identify the custom setting. -
settingValueType string false The value type of the custom setting. BENEFIT_PLANS_BY_SOURCE_ID, DATA_PARTITION_ID, DATA_PARTITION_IDS, ISO_8601_STRING, ISO_8601_STRINGS, NUMBER, NUMBERS, ORGANIZATION, ORGANIZATION_RECORDS, ORG_IDS_BY_ORG_CLASS, ORG_NAME_BY_ID, ORG_SERVICE_POSTAL_CODES_BY_ID, PERSONNEL_BY_ID, PERSONNEL_BY_ORG_ID, PERSONNEL_GROUP_BY_ID, PRSNL_ORG_COMMITMENT_BY_ORG_ID, STRING, STRINGS

postPipelines

Name Type Required Description Accepted Values
name string true The name of the pipeline. -
population object true The unique population ID. -
» id string true The unique ID of the population. -
state string true state. -
executionSettings object false The execution setting values. -
» frequencyValue integer(int32) true The frequency value defining how often a coordinator will run. -
» frequencyUnit string true The frequency unit in which frequency occurs and the allowed values are minutes, hours, days, and months. -
» timeOfDay string true The time of day (HH:MM) in Coordinated Universal Time (UTC) when a coordinator instance job will run. -
properties [object] false Properties key and values. -
» key string true The pipeline properties key. -
» value string true The pipeline properties value. -
job object false The ID or version pair for adding arbitrary metadata. -
» id string true The unique ID of the job. -
» version integer(int32) true The version number of the job. -

AttributionPublicApi_Entities_V1_Pipeline_Pipeline

Name Type Required Description Accepted Values
id string true The unique ID of the pipeline. -
version integer(int32) true The version of the pipeline. -
name string true The name of the pipeline. -
population AttributionPublicApi_Entities_V1_PopulationReference true The unique ID of the population that identifies the longitudinal records used to process the attributions. -
state string true A value to denote the state of the pipeline. ACTIVE, INACTIVE, ACTIVE_ADHOC
executionSettings AttributionPublicApi_Entities_V1_Pipeline_PipelineExecutionSetting true The pipeline execution settings. -
lastRunStatus string true The status of the pipeline execution during the last run. COMPLETED, FAILED
lastSuccessfulRun string true The date and time that the last execution of the pipeline stopped its work. -
properties [AttributionPublicApi_Entities_V1_Pipeline_PipelinePropSetting] false The list of pipeline properties. -
job AttributionPublicApi_Entities_V1_Pipeline_PipelineJobSetting true The job properties which contain the job ID and version. -
tags [AttributionPublicApi_Entities_V1_Pipeline_PipelineTagSetting] false An optional list of tags for the pipeline. -
createdAt string true The date and time when the pipeline was initially entered in the system. This value is provided in International Organization for Standardization (ISO) 8601 formatting with precision to YYYY-MM-DDThh:mm:ss.SSSZ, such as 2018-02-13T20:41:18.181Z. The time is set automatically when the pipeline is first created. Therefore, the field does not need to be set explicitly. -
updatedAt string true The date and time when the pipeline was updated in the system. This value is provided in ISO 8601 formatting with precision to YYYY-MM-DDThh:mm:ss.SSSZ, such as 2018-02-13T20:41:18.181Z. The time is set automatically when the pipeline is updated. Therefore, the field does not need to be set explicitly. -

AttributionPublicApi_Entities_V1_Pipeline_PipelineExecutionSetting

Name Type Required Description Accepted Values
frequencyValue integer(int32) true The frequency value defining how often a coordinator will run. -
frequencyUnit string true The frequency unit in which frequency occurs and the allowed values are minutes, hours, days, and months. -
timeOfDay string true The time of day (HH:MM) in Coordinated Universal Time (UTC) when a coordinator instance job should run. -

AttributionPublicApi_Entities_V1_Pipeline_PipelinePropSetting

Name Type Required Description Accepted Values
key string true The key of the pipeline property setting. -
value string true The value of the pipeline property settings key. -

AttributionPublicApi_Entities_V1_Pipeline_PipelineJobSetting

Name Type Required Description Accepted Values
id string true The unique ID of the job. -
version integer(int32) true The version number of the job. -

AttributionPublicApi_Entities_V1_Pipeline_PipelineTagSetting

Name Type Required Description Accepted Values
key string true The key for the pipline tag settings. -
value string false The value of the pipeline tag key. -

Pipelines

Name Type Required Description Accepted Values
items [AttributionPublicApi_Entities_V1_Pipeline_Pipeline] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -

putPipelines

Name Type Required Description Accepted Values
name string true The name of the pipeline. -
population object true The unique population ID. -
» id string true The unique ID of the population. -
state string true state. -
executionSettings object false The execution setting values. -
» frequencyValue integer(int32) true The frequency value defining how often a coordinator will run. -
» frequencyUnit string true The frequency unit in which frequency occurs and the allowed values are minutes, hours, days, and months. -
» timeOfDay string true The time of day (HH:MM) in Coordinated Universal Time (UTC) when a coordinator instance job will run. -
properties [object] false Properties key and values. -
» key string true The pipeline properties key. -
» value string true The pipeline properties value. -
job object false The ID or version pair for adding arbitrary metadata. -
» id string true The unique ID of the job. -
» version integer(int32) true The version number of the job. -

postTags

Name Type Required Description Accepted Values
key string true The tag key. -
value string false The tag key value. -
resource object true The resource attribute information of the tag. -
» id string true The unique pipeline ID or job ID. -
» type string true The resource type for the given resource ID example (“PIPELINE” or “JOB”). -

AttributionPublicApi_Entities_V1_Tag_Tag

Name Type Required Description Accepted Values
id string true The unique ID of the tag. -
key string true The key of the tag. -
value string false The value of the tag. -
resource AttributionPublicApi_Entities_V1_TagResource true The resource settings of the tag. -

AttributionPublicApi_Entities_V1_TagResource

Name Type Required Description Accepted Values
id string true The unique ID of the pipeline or job. -
type string true A string to denote the pipeline or job. -

Tags

Name Type Required Description Accepted Values
items [AttributionPublicApi_Entities_V1_Tag_Tag] true An array containing the current page of results. -
totalResults integer(int32) false The total number of results for the specified parameters. -
firstLink string true The first page of results. -
lastLink string false The last page of results. -
prevLink string false The previous page of results. -
nextLink string false The next page of results. -
Ruby Shell