API Stability Preview

The linkChildOrganization() GraphQL mutation may be used to link a sub-organization to the main one.

Syntax

graphql
linkChildOrganization(
      childId: string!
   ): OrganizationLink!

There is no special input datatype for this mutation field.

Example

Below is an example of how this mutation field might be used:

Raw
graphql
mutation {
  linkChildOrganization(
    childId: "123abc"
    )
  { parentOrganization {name, id} }
}
Mac OS or Linux (curl)
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  linkChildOrganization(
    childId: \"123abc\"
    )
  { parentOrganization {name, id} }
}"
}
EOF
Mac OS or Linux (curl) One-line
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql \
    -H "Authorization: Bearer $TOKEN" \
    -H "Content-Type: application/json" \
    -d @- << EOF
{"query" : "mutation {
  linkChildOrganization(
    childId: \"123abc\"
    )
  { parentOrganization {name, id} }
}"
}
EOF
Windows Cmd and curl
shell
curl -v -X POST $YOUR_LOGSCALE_URL/graphql ^
    -H "Authorization: Bearer $TOKEN" ^
    -H "Content-Type: application/json" ^
    -d @'{"query" : "mutation { ^
  linkChildOrganization( ^
    childId: \"123abc\" ^
    ) ^
  { parentOrganization {name, id} } ^
}" ^
} '
Windows Powershell and curl
powershell
curl.exe -X POST 
    -H "Authorization: Bearer $TOKEN"
    -H "Content-Type: application/json"
    -d '{"query" : "mutation {
  linkChildOrganization(
    childId: \"123abc\"
    )
  { parentOrganization {name, id} }
}"
}'
    "$YOUR_LOGSCALE_URL/graphql"
Perl
perl
#!/usr/bin/perl

use HTTP::Request;
use LWP;

my $TOKEN = "TOKEN";

my $uri = '$YOUR_LOGSCALE_URL/graphql';

my $query = "mutation {
  linkChildOrganization(
    childId: \"123abc\"
    )
  { parentOrganization {name, id} }
}";
$query =~ s/\n/ /g;
my $json = sprintf('{"query" : "%s"}',$query);
my $req = HTTP::Request->new("POST", $uri );

$req->header("Authorization" => "Bearer $TOKEN");
$req->header("Content-Type" => "application/json");

$req->content( $json );

my $lwp = LWP::UserAgent->new;

my $result = $lwp->request( $req );

print $result->{"_content"},"\n";
Python
python
#! /usr/local/bin/python3

import requests

url = '$YOUR_LOGSCALE_URL/graphql'
mydata = r'''{"query" : "mutation {
  linkChildOrganization(
    childId: \"123abc\"
    )
  { parentOrganization {name, id} }
}"
}'''

resp = requests.post(url,
                     data = mydata,
                     headers = {
   "Authorization" : "Bearer $TOKEN",
   "Content-Type" : "application/json"
}
)

print(resp.text)
Node.js
javascript
const https = require('https');

const data = JSON.stringify(
    {"query" : "mutation {
  linkChildOrganization(
    childId: \"123abc\"
    )
  { parentOrganization {name, id} }
}"
}
);


const options = {
  hostname: '$YOUR_LOGSCALE_URL',
  path: 'graphql',
  port: 443,
  method: 'POST',
  headers: {
    'Content-Type': 'application/json',
    'Content-Length': data.length,
    Authorization: 'BEARER ' + process.env.TOKEN,
    'User-Agent': 'Node',
  },
};

const req = https.request(options, (res) => {
  let data = '';
  console.log(`statusCode: ${res.statusCode}`);

  res.on('data', (d) => {
    data += d;
  });
  res.on('end', () => {
    console.log(JSON.parse(data).data);
  });
});

req.on('error', (error) => {
  console.error(error);
});

req.write(data);
req.end();
Example Responses
Success (HTTP Response Code 200 OK)
json
{
  "data": {
    "linkChildOrganization": {
      "parentOrganization": {
        "name": "mom"
        "id": "abc123"
      }
    }
  }
}

Returned Datatype

For the returned datatype, you can get information on the parent and the child organization, such as each organization's configuration and URLs, any organization limits, and other data. The table below has links to a table with these sub-parameters and others: