Wikirate platform can host answers that respond to relationship questions between companies. For instance, which companies supplied company A in 2022? Relationship answers respond to such questions (metrics with metric type Relationship Metric).
This example assumes you have configured your Wikirate REST client. Instructions on how to configure a client can be
found in examples/Configurations.md
The get_relationship answers method take as an input the metric_name, metric_designer and a Hash where the user
can define the parameters of their request. More specifically, we could divide our params in two different types of
parameters, the endpoint parameters and the filter parameters. The endpoint parameters help us to iterate through our
query's results and the filter parameters allow us to restrict our results based on specific given input.
- limit: default value 20, the maximum number of entries to return. If the value exceeds the maximum, then the maximum value will be used.
- offset: default value 0, the (zero-based) offset of the first item in the collection to return
filter params:
- year: returns all the relationships reported on the defined year
- source: returns all relationships that cite the defined source
- name: returns all relationships with the subject company name containing the given string
In the example below, we are looking for Adidas AG suppliers in 2021.
relationship_answers = client.get_relationship_answers('Supplied By',
'Commons',
{ 'year' => 2021,
'name' => 'Adidas AG' })
puts relationship_answersThe get_relationship_answers_by_metric_id functions similarly with the get_relationship_answers method but instead
of metric_name and metric_designer gets as an input the metric_id.
Thus, the examples equivalent examples of the previous section using the metric_id will be formulated as follows:
In the example below, we are looking for Adidas AG suppliers in 2021.
relationship_answers = client.get_relationship_answers(2929009,
{ 'year' => 2021,
'name' => 'Adidas AG' })
puts relationship_answers