API Reference

POST scores

Publishes a new score from a source score file specified by URL.

Resource URL

https://api.us-east-1.everywhere.avid.com/apis/avid.sibelius.publishing;version=2;realm=global/scores

Parameters

Parameter Required Description Example values
scoreUrl Required Publicly accessible URL to the score https://www.sibelius.com/my-great-score.sib
scoreId Optional User-assignable score ID/alias myGreatScore
options Optional Publishing options {}
options.transpose Optional Enables rendering of transposed scores false

Example request

1
2
3
4
5
6
POST /apis/avid.sibelius.publishing;version=2;realm=global/scores

{
  "scoreUrl": "https://www.sibelius.com/my-great-score.sib",
  "scoreId": "myGreatScore"
}

Example response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
HTTP/1.1 200 OK

{
  "score": {
    "publisher": {
      "publisherId": "avid",
      "scoreId": "myGreatScore",
      "identity": { … }
    },
    "scoreUrl": "https://www.sibelius.com/my-great-score.sib",
    "createdAt": "2016-10-26T04:28:41.130Z",
    "status": "pending",
    "updatedAt": "2016-10-26T04:53:15.682Z",
    "id": "c96db2ba-1d1f-4aa2-82fb-a2cd1848097b"
  }
}

GET scores

Gets scores. Returns 50 scores by default. You may optionally specify offset
and limit values to control the number of scores returned.

Resource URL

https://api.us-east-1.everywhere.avid.com/apis/avid.sibelius.publishing;version=2;realm=global/scores

Parameters

Parameter Required Description Example values
score Optional Score object with searchable parameters { "status": "pending" }
offset Optional Offset search results 20
limit Optional Limit search results, default 50, maximum 100 25

Example request

This request searches for all scores with a status of “pending”, and limits
the number of results to 1.

1
2
3
4
5
6
7
8
GET /apis/avid.sibelius.publishing;version=2;realm=global/scores

{
  "score": {
    "status": "pending"
  },
  "limit": 1
}

Example response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
HTTP/1.1 200 OK

{
  "scores": [
    {
      "publisher": {
        "publisherId": "avid",
        "scoreId": "myGreatScore",
        "identity": { … }
      },
      "scoreUrl": "https://www.sibelius.com/my-great-score.sib",
      "createdAt": "2016-10-26T04:28:41.130Z",
      "status": "pending",
      "updatedAt": "2016-10-26T04:56:49.020Z",
      "renderings": [ … ],
      "id": "c96db2ba-1d1f-4aa2-82fb-a2cd1848097b"
    }
  ]
}

POST scores/count

Gets score count.

Resource URL

https://api.us-east-1.everywhere.avid.com/apis/avid.sibelius.publishing;version=2;realm=global/scores/count

Parameters

Parameter Required Description Example values
score Optional Score object allowing you to get the count of scores that match certain criteria
offset Optional Offset where score counting should begin 20
limit Optional Limit the number of scores to count 25

Example request

This request searches for all scores with a status of “pending”, and limits
the number of results to 1.

1
GET /apis/avid.sibelius.publishing;version=2;realm=global/scores

Example response

1
2
3
4
5
HTTP/1.1 200 OK

{
  "count": 1618
}

GET scores/:id

Gets a score by ID. The ID may be either the one specified when publishing the
score using the scoreId parameter or the unique UUID that is automatically
generated for the published score.

Resource URL

https://api.us-east-1.everywhere.avid.com/apis/avid.sibelius.publishing;version=2;realm=global/scores/:id

Parameters

None

Example request

This request retrieves a score with the ID of myGreatScore. 

1
GET /apis/avid.sibelius.publishing;version=2;realm=global/scores/myGreatScore

Example response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
HTTP/1.1 200 OK

{
  "scores": [
    {
      "publisher": {
        "publisherId": "avid",
        "scoreId": "myGreatScore",
        "identity": { … }
      },
      "scoreUrl": "https://www.sibelius.com/my-great-score.sib",
      "createdAt": "2016-10-26T04:28:41.130Z",
      "status": "pending",
      "updatedAt": "2016-10-26T04:56:49.020Z",
      "renderings": [ … ],
      "id": "c96db2ba-1d1f-4aa2-82fb-a2cd1848097b"
    }
  ]
}

DELETE scores/:id

Deletes a score by ID.

Resource URL

https://api.us-east-1.everywhere.avid.com/apis/avid.sibelius.publishing;version=2;realm=global/scores/:scoreId

Parameters

Parameter Required Description Example values
purge Optional Controls whether rendered assets for this score are purged true, false

Example request

This request deletes a score and purges all renderings.

1
2
3
4
5
DELETE /apis/avid.sibelius.publishing;version=2;realm=global/scores/myGreatScore

{
  "purge": "true"
}

Example response

1
2
3
4
5
HTTP/1.1 200 OK

{
  "score": {}
}

POST scores/:scoreId/view

Creates a new view of a score.

Resource URL

https://api.us-east-1.everywhere.avid.com/apis/avid.sibelius.publishing;version=2;realm=global/scores/:scoreId/view

Parameters

Parameter Required Description Example values
settings.printable Optional Controls whether user is able to print from viewer true, false
settings.pages Optional Controls the number of pages displayed to the user 1,4,6-10
settings.licenseString Optional Allows you to embed a string into the view of the score, intended for licensing information Licensed to Joe Bloggs
settings.lang Optional Controls the language of the viewer, specified as a string in the format defined in Tags for Identifying Languages (BCP47)
expiresIn Optional Allows you to specify the time (in seconds) that the view should remain active for. Minimum is 0 and maximum is 86400 (24 hours) 7200

Example request

1
2
3
4
5
6
7
8
GET /apis/avid.sibelius.publishing;version=2;realm=global/scores/5adf7fc7-68b0-478f-ab08-3ecec0ab297c/view

{
  "settings": {
    "printable": "true",
    "pages": "2,3"
  }
}

Example response

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
HTTP/1.1 200 OK

  "session": {
    "scoreId": "c4ba71e0-0817-473f-b323-4ce82e5d32fb",
    "expiresAt": "2016-10-27T03:07:01.665Z",
    "createdAt": "2016-10-27T01:07:01.665Z",
    "token": "NDYxZDFhMmEtYWU2OS00ODYwLTlhZGYtNzEyMTQ5YWU5NmVi",
    "settings": {
      "printable": true,
      "pages": "2,3"
    },
    "id": "c9f11a98-efa1-4602-964a-92e93532ab37",
    "viewerUrl": "https://static-everywhere.avid.com/static/apps/avid-sibelius-publishing-viewer/?session=c9f11a98-efa1-4602-964a-92e93532ab37&token=NDYxZDFhMmEtYWU2OS00ODYwLTlhZGYtNzEyMTQ5YWU5NmVi"
  }
}

GET core/health

Checks service health. Also useful for checking connectivity with the Cloud
Publishing API.

Resource URL

https://api.us-east-1.everywhere.avid.com/apis/avid.sibelius.publishing;version=2;realm=global/core/health

Note: This isn’t strictly part of the public API so should not be relied
upon.

Parameters

None

Example request

1
GET /apis/avid.sibelius.publishing;version=2;realm=global/core/health

Example response

1
2
3
4
5
6
7
8
9
10
HTTP/1.1 200 OK

{
  "service": {
    "healthStatus": "ok",
    "healthVerifier": "default"
  },
  "connector": { … },
  "route": [ … ]
}