ISWC Database Agency REST API

API change history

ISWC Database Agency/Society REST API

Update the status of an outstanding Workflow Tasks associated with an Agency

Update the status of an outstanding Workflow Tasks associated with an Agency

Try it

Request

Request URL

Request parameters

  • string

    CISAC Agency identifier

Request headers

  • (optional)
    string
    Media type of the body sent to the API.
  • string
    Subscription key which provides access to this API. Found in your Profile.

Request body

[
  {
    "taskId": 0,
    "workflowType": "UpdateApproval",
    "status": "Outstanding",
    "workflowMessage": "string"
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "taskId": {
        "type": "integer",
        "format": "int32"
      },
      "workflowType": {
        "enum": [
          "UpdateApproval",
          "MergeApproval",
          "DemergeApproval"
        ],
        "type": "string"
      },
      "status": {
        "enum": [
          "Outstanding",
          "Approved",
          "Rejected",
          "Cancelled"
        ],
        "type": "string"
      },
      "workflowMessage": {
        "maxLength": 200,
        "type": "string",
        "description": "The reason for the workflow update"
      }
    }
  },
  "x-apim-inline": true
}
<IswcWorkflowTasksPatchRequest-2> <taskId>0</taskId> <workflowType>UpdateApproval</workflowType> <status>Outstanding</status> <workflowMessage>string</workflowMessage> </IswcWorkflowTasksPatchRequest-2>
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "taskId": {
        "type": "integer",
        "format": "int32"
      },
      "workflowType": {
        "enum": [
          "UpdateApproval",
          "MergeApproval",
          "DemergeApproval"
        ],
        "type": "string"
      },
      "status": {
        "enum": [
          "Outstanding",
          "Approved",
          "Rejected",
          "Cancelled"
        ],
        "type": "string"
      },
      "workflowMessage": {
        "maxLength": 200,
        "type": "string",
        "description": "The reason for the workflow update"
      }
    }
  },
  "x-apim-inline": true
}

Responses

207 Multi-Status

Workflow Task updated

Representations

[
  {
    "workflowTaskId": 0,
    "workflowType": "UpdateApproval",
    "status": "Outstanding",
    "createdDate": "string",
    "originatingSociety": "string",
    "assignedSociety": "string",
    "iswcMetadata": {
      "createdDate": "string",
      "lastModifiedDate": "string",
      "lastModifiedBy": "string",
      "iswc": "string",
      "agency": "string",
      "originalTitle": "string",
      "otherTitles": [
        {
          "title": "string",
          "type": "CT"
        }
      ],
      "interestedParties": [
        {
          "name": "string",
          "lastName": "string",
          "nameNumber": 0,
          "baseNumber": "string",
          "affiliation": "string",
          "role": "CA",
          "legalEntityType": "N"
        }
      ],
      "works": [
        {
          "id": 0,
          "iswc": "string",
          "iswcEligible": true,
          "deleted": true,
          "linkedFrom": "string",
          "linkedTo": "string",
          "rejection": {
            "code": "string",
            "message": "string"
          },
          "archivedIswc": "string",
          "overallParentISWC": "string",
          "agency": "string",
          "sourcedb": 0,
          "workcode": "string",
          "category": "DOM",
          "disambiguation": true,
          "disambiguationReason": "DIT",
          "disambiguateFrom": [
            {
              "iswc": "string"
            }
          ],
          "bvltr": "Background",
          "derivedWorkType": "ModifiedVersion",
          "derivedFromIswcs": [
            {
              "iswc": "string",
              "title": "string"
            }
          ],
          "performers": [
            {
              "firstName": "string",
              "lastName": "string"
            }
          ],
          "instrumentation": [
            {
              "code": "string"
            }
          ],
          "cisnetCreatedDate": "string",
          "cisnetLastModifiedDate": "string",
          "additionalIdentifiers": {
            "isrcs": [
              "string"
            ],
            "publisherIdentifiers": [
              {
                "nameNumber": 0,
                "submitterCode": "string",
                "workCode": [
                  "string"
                ]
              }
            ],
            "agencyWorkCodes": [
              {
                "agency": "string",
                "workCode": "string"
              }
            ]
          },
          "originalTitle": "string",
          "otherTitles": [
            {
              "title": "string",
              "type": "CT"
            }
          ],
          "interestedParties": [
            {
              "name": "string",
              "lastName": "string",
              "nameNumber": 0,
              "baseNumber": "string",
              "affiliation": "string",
              "role": "CA",
              "legalEntityType": "N"
            }
          ],
          "createdDate": "string",
          "lastModifiedDate": "string",
          "lastModifiedBy": "string"
        }
      ],
      "parentISWC": "string",
      "linkedISWC": [
        "string"
      ],
      "overallParentISWC": "string"
    },
    "rejection": {
      "code": "string",
      "message": "string"
    },
    "workflowMessage": "string"
  }
]
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "workflowTaskId": {
        "type": "integer",
        "format": "int32"
      },
      "workflowType": {
        "enum": [
          "UpdateApproval",
          "MergeApproval",
          "DemergeApproval"
        ],
        "type": "string"
      },
      "status": {
        "enum": [
          "Outstanding",
          "Approved",
          "Rejected",
          "Cancelled"
        ],
        "type": "string"
      },
      "createdDate": {
        "type": "string",
        "format": "date-time"
      },
      "originatingSociety": {
        "maxLength": 3,
        "minLength": 3,
        "type": "string"
      },
      "assignedSociety": {
        "maxLength": 3,
        "minLength": 3,
        "type": "string"
      },
      "iswcMetadata": {
        "allOf": [
          {
            "properties": {
              "createdDate": {
                "type": "string",
                "description": "Data and time of creation in the system",
                "format": "date-time"
              },
              "lastModifiedDate": {
                "type": "string",
                "description": "Data and time of the latest update in the system",
                "format": "date-time"
              },
              "lastModifiedBy": {
                "type": "string",
                "description": "Identifier of the last update in the system"
              }
            }
          },
          {
            "required": [
              "originalTitle",
              "interestedParties"
            ],
            "properties": {
              "iswc": {
                "pattern": "T[0-9]{10}",
                "type": "string"
              },
              "agency": {
                "maxLength": 3,
                "minLength": 3,
                "type": "string",
                "description": "A CISAC code of a submitting agency that allocated this ISWC"
              },
              "originalTitle": {
                "type": "string",
                "description": "Original title of a musical composition"
              },
              "otherTitles": {
                "type": "array",
                "items": {
                  "required": [
                    "title",
                    "type"
                  ],
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "string",
                      "description": "Musical work title"
                    },
                    "type": {
                      "enum": [
                        "CT",
                        "OT",
                        "RT",
                        "AT",
                        "ET",
                        "ST",
                        "TO",
                        "OA",
                        "TE",
                        "FT",
                        "IT",
                        "TT",
                        "PT",
                        "OL",
                        "AL"
                      ],
                      "type": "string",
                      "description": "Musical work title type"
                    }
                  }
                },
                "description": "Other titles associated with musical composition (aka alternative titles)"
              },
              "interestedParties": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string"
                    },
                    "lastName": {
                      "type": "string"
                    },
                    "nameNumber": {
                      "type": "integer",
                      "format": "int64"
                    },
                    "baseNumber": {
                      "type": "string"
                    },
                    "affiliation": {
                      "type": "string"
                    },
                    "role": {
                      "enum": [
                        "CA",
                        "AR",
                        "SE",
                        "PA",
                        "ES",
                        "AM",
                        "SA",
                        "C",
                        "AD",
                        "A",
                        "E",
                        "AQ",
                        "SR",
                        "TR",
                        "MA",
                        "TA"
                      ],
                      "type": "string",
                      "description": "The role will be rolled up to the corresponding CISAC Role as per the following mapping: C(C,A,CA), MA(AR,SR), TA(AD,SA,TR) E(E,AM)"
                    },
                    "legalEntityType": {
                      "enum": [
                        "N",
                        "L"
                      ],
                      "type": "string"
                    }
                  }
                },
                "description": "Interested party associated with musical composition, such as :composers, lyricist, translator, original and sub publishers"
              }
            }
          },
          {
            "required": [
              "iswc",
              "agency"
            ],
            "type": "object",
            "properties": {
              "works": {
                "type": "array",
                "items": {
                  "required": [
                    "id",
                    "iswc",
                    "deleted"
                  ],
                  "allOf": [
                    {
                      "required": [
                        "agency",
                        "sourcedb",
                        "workcode",
                        "category",
                        "originalTitle",
                        "interestedParties"
                      ],
                      "allOf": [
                        {
                          "required": [
                            "originalTitle",
                            "interestedParties"
                          ],
                          "properties": {
                            "iswc": {
                              "pattern": "T[0-9]{10}",
                              "type": "string"
                            },
                            "agency": {
                              "maxLength": 3,
                              "minLength": 3,
                              "type": "string",
                              "description": "A CISAC code of a submitting agency that allocated this ISWC"
                            },
                            "originalTitle": {
                              "type": "string",
                              "description": "Original title of a musical composition"
                            },
                            "otherTitles": {
                              "type": "array",
                              "items": {
                                "required": [
                                  "title",
                                  "type"
                                ],
                                "type": "object",
                                "properties": {
                                  "title": {
                                    "type": "string",
                                    "description": "Musical work title"
                                  },
                                  "type": {
                                    "enum": [
                                      "CT",
                                      "OT",
                                      "RT",
                                      "AT",
                                      "ET",
                                      "ST",
                                      "TO",
                                      "OA",
                                      "TE",
                                      "FT",
                                      "IT",
                                      "TT",
                                      "PT",
                                      "OL",
                                      "AL"
                                    ],
                                    "type": "string",
                                    "description": "Musical work title type"
                                  }
                                }
                              },
                              "description": "Other titles associated with musical composition (aka alternative titles)"
                            },
                            "interestedParties": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "name": {
                                    "type": "string"
                                  },
                                  "lastName": {
                                    "type": "string"
                                  },
                                  "nameNumber": {
                                    "type": "integer",
                                    "format": "int64"
                                  },
                                  "baseNumber": {
                                    "type": "string"
                                  },
                                  "affiliation": {
                                    "type": "string"
                                  },
                                  "role": {
                                    "enum": [
                                      "CA",
                                      "AR",
                                      "SE",
                                      "PA",
                                      "ES",
                                      "AM",
                                      "SA",
                                      "C",
                                      "AD",
                                      "A",
                                      "E",
                                      "AQ",
                                      "SR",
                                      "TR",
                                      "MA",
                                      "TA"
                                    ],
                                    "type": "string",
                                    "description": "The role will be rolled up to the corresponding CISAC Role as per the following mapping: C(C,A,CA), MA(AR,SR), TA(AD,SA,TR) E(E,AM)"
                                  },
                                  "legalEntityType": {
                                    "enum": [
                                      "N",
                                      "L"
                                    ],
                                    "type": "string"
                                  }
                                }
                              },
                              "description": "Interested party associated with musical composition, such as :composers, lyricist, translator, original and sub publishers"
                            }
                          }
                        },
                        {
                          "type": "object"
                        }
                      ],
                      "properties": {
                        "agency": {
                          "maxLength": 3,
                          "minLength": 3,
                          "type": "string"
                        },
                        "sourcedb": {
                          "type": "integer",
                          "format": "int32"
                        },
                        "workcode": {
                          "type": "string"
                        },
                        "category": {
                          "enum": [
                            "DOM",
                            "INT"
                          ],
                          "type": "string"
                        },
                        "disambiguation": {
                          "type": "boolean"
                        },
                        "disambiguationReason": {
                          "enum": [
                            "DIT",
                            "DIA",
                            "DIE",
                            "DIC",
                            "DIP",
                            "DIV"
                          ],
                          "type": "string",
                          "description": "Disambiguation Reason Code"
                        },
                        "disambiguateFrom": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "iswc": {
                                "pattern": "T[0-9]{10}",
                                "type": "string"
                              }
                            }
                          }
                        },
                        "bvltr": {
                          "enum": [
                            "Background",
                            "Logo",
                            "Theme",
                            "Visual",
                            "RolledUpCue"
                          ],
                          "type": "string",
                          "description": "Background, Logo, Theme, Visual or Rolled Up Cue"
                        },
                        "derivedWorkType": {
                          "enum": [
                            "ModifiedVersion",
                            "Excerpt",
                            "Composite"
                          ],
                          "type": "string",
                          "description": "Derived Work Type- if not provided then this isn't a derived work"
                        },
                        "derivedFromIswcs": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "iswc": {
                                "pattern": "T[0-9]{10}",
                                "type": "string"
                              },
                              "title": {
                                "type": "string"
                              }
                            }
                          }
                        },
                        "performers": {
                          "type": "array",
                          "items": {
                            "required": [
                              "lastName"
                            ],
                            "type": "object",
                            "properties": {
                              "firstName": {
                                "maxLength": 50,
                                "minLength": 1,
                                "type": "string"
                              },
                              "lastName": {
                                "maxLength": 50,
                                "minLength": 1,
                                "type": "string"
                              }
                            }
                          }
                        },
                        "instrumentation": {
                          "type": "array",
                          "items": {
                            "required": [
                              "code"
                            ],
                            "type": "object",
                            "properties": {
                              "code": {
                                "maxLength": 3,
                                "minLength": 1,
                                "type": "string"
                              }
                            }
                          }
                        },
                        "cisnetCreatedDate": {
                          "type": "string",
                          "description": "Date and time when this metadata was created on CISNET",
                          "format": "date-time"
                        },
                        "cisnetLastModifiedDate": {
                          "type": "string",
                          "description": "Date and time when this metadata last modified on CISNET",
                          "format": "date-time"
                        },
                        "additionalIdentifiers": {
                          "type": "object",
                          "properties": {
                            "isrcs": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "publisherIdentifiers": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "nameNumber": {
                                    "type": "integer",
                                    "format": "int64"
                                  },
                                  "submitterCode": {
                                    "type": "string"
                                  },
                                  "workCode": {
                                    "type": "array",
                                    "items": {
                                      "type": "string"
                                    }
                                  }
                                }
                              }
                            },
                            "agencyWorkCodes": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "agency": {
                                    "maxLength": 3,
                                    "minLength": 3,
                                    "type": "string"
                                  },
                                  "workCode": {
                                    "maxLength": 20,
                                    "type": "string"
                                  }
                                }
                              }
                            }
                          },
                          "description": "Optional list of additional identifiers that can be supplied with the submission."
                        }
                      }
                    },
                    {
                      "properties": {
                        "createdDate": {
                          "type": "string",
                          "description": "Data and time of creation in the system",
                          "format": "date-time"
                        },
                        "lastModifiedDate": {
                          "type": "string",
                          "description": "Data and time of the latest update in the system",
                          "format": "date-time"
                        },
                        "lastModifiedBy": {
                          "type": "string",
                          "description": "Identifier of the last update in the system"
                        }
                      }
                    },
                    {
                      "type": "object"
                    }
                  ],
                  "properties": {
                    "id": {
                      "type": "integer",
                      "description": "An unique identifier assigned by the system",
                      "format": "int64"
                    },
                    "iswc": {
                      "description": "A preferred ISWC assigned by the system"
                    },
                    "iswcEligible": {
                      "type": "boolean",
                      "description": "Indicator of a submitter being Iswc Eligible"
                    },
                    "deleted": {
                      "type": "boolean",
                      "description": "Indicator of a submission being logically deleted on CSINET"
                    },
                    "linkedFrom": {
                      "pattern": "T[0-9]{10}",
                      "type": "string",
                      "description": "The ISWC record that this is linked from"
                    },
                    "linkedTo": {
                      "pattern": "T[0-9]{10}",
                      "type": "string",
                      "description": "The ISWC record that this is linked to"
                    },
                    "rejection": {
                      "required": [
                        "code",
                        "message"
                      ],
                      "properties": {
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    },
                    "archivedIswc": {
                      "pattern": "T[0-9]{10}",
                      "type": "string",
                      "description": "The Archived ISWC"
                    },
                    "overallParentISWC": {
                      "pattern": "T[0-9]{10}",
                      "type": "string",
                      "description": "The preferred ISWC that is at the top of the chain of ISWCs."
                    }
                  }
                }
              },
              "parentISWC": {
                "pattern": "T[0-9]{10}",
                "type": "string",
                "description": "A preferred ISWC of a parent of this ISWC. Presence of this field indicates that the ISWC merged to the parent."
              },
              "linkedISWC": {
                "type": "array",
                "items": {
                  "pattern": "T[0-9]{10}",
                  "type": "string"
                },
                "description": "All linked preferred ISWCs. Presence of this field indicates that those ISWCs merged to this ISWC."
              },
              "overallParentISWC": {
                "pattern": "T[0-9]{10}",
                "type": "string",
                "description": "The preferred ISWC that is at the top of the chain of ISWCs."
              }
            },
            "xml": {
              "name": "ISWCMetadata"
            }
          }
        ]
      },
      "rejection": {
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      },
      "workflowMessage": {
        "maxLength": 200,
        "type": "string",
        "description": "The reason for the workflow update"
      }
    }
  },
  "x-apim-inline": true
}
<Batch> <Batch> <workflowTaskId>0</workflowTaskId> <workflowType>UpdateApproval</workflowType> <status>Outstanding</status> <createdDate>string</createdDate> <originatingSociety>string</originatingSociety> <assignedSociety>string</assignedSociety> <iswcMetadata> <createdDate>string</createdDate> <lastModifiedDate>string</lastModifiedDate> <lastModifiedBy>string</lastModifiedBy> <iswc>string</iswc> <agency>string</agency> <originalTitle>string</originalTitle> <otherTitles> <title>string</title> <type>CT</type> </otherTitles> <interestedParties> <name>string</name> <lastName>string</lastName> <nameNumber>0</nameNumber> <baseNumber>string</baseNumber> <affiliation>string</affiliation> <role>CA</role> <legalEntityType>N</legalEntityType> </interestedParties> <works> <id>0</id> <iswc /> <iswcEligible>true</iswcEligible> <deleted>true</deleted> <linkedFrom>string</linkedFrom> <linkedTo>string</linkedTo> <rejection> <code>string</code> <message>string</message> </rejection> <archivedIswc>string</archivedIswc> <overallParentISWC>string</overallParentISWC> <agency>string</agency> <sourcedb>0</sourcedb> <workcode>string</workcode> <category>DOM</category> <disambiguation>true</disambiguation> <disambiguationReason>DIT</disambiguationReason> <disambiguateFrom> <iswc>string</iswc> </disambiguateFrom> <bvltr>Background</bvltr> <derivedWorkType>ModifiedVersion</derivedWorkType> <derivedFromIswcs> <iswc>string</iswc> <title>string</title> </derivedFromIswcs> <performers> <firstName>string</firstName> <lastName>string</lastName> </performers> <instrumentation> <code>string</code> </instrumentation> <cisnetCreatedDate>string</cisnetCreatedDate> <cisnetLastModifiedDate>string</cisnetLastModifiedDate> <additionalIdentifiers> <isrcs>string</isrcs> <publisherIdentifiers> <nameNumber>0</nameNumber> <submitterCode>string</submitterCode> <workCode>string</workCode> </publisherIdentifiers> <agencyWorkCodes> <agency>string</agency> <workCode>string</workCode> </agencyWorkCodes> </additionalIdentifiers> <iswc>string</iswc> <agency>string</agency> <originalTitle>string</originalTitle> <otherTitles> <title>string</title> <type>CT</type> </otherTitles> <interestedParties> <name>string</name> <lastName>string</lastName> <nameNumber>0</nameNumber> <baseNumber>string</baseNumber> <affiliation>string</affiliation> <role>CA</role> <legalEntityType>N</legalEntityType> </interestedParties> <createdDate>string</createdDate> <lastModifiedDate>string</lastModifiedDate> <lastModifiedBy>string</lastModifiedBy> </works> <parentISWC>string</parentISWC> <linkedISWC>string</linkedISWC> <overallParentISWC>string</overallParentISWC> </iswcMetadata> <rejection> <code>string</code> <message>string</message> </rejection> <workflowMessage>string</workflowMessage> </Batch> </Batch>
{
  "type": "array",
  "items": {
    "type": "object",
    "properties": {
      "workflowTaskId": {
        "type": "integer",
        "format": "int32"
      },
      "workflowType": {
        "enum": [
          "UpdateApproval",
          "MergeApproval",
          "DemergeApproval"
        ],
        "type": "string"
      },
      "status": {
        "enum": [
          "Outstanding",
          "Approved",
          "Rejected",
          "Cancelled"
        ],
        "type": "string"
      },
      "createdDate": {
        "type": "string",
        "format": "date-time"
      },
      "originatingSociety": {
        "maxLength": 3,
        "minLength": 3,
        "type": "string"
      },
      "assignedSociety": {
        "maxLength": 3,
        "minLength": 3,
        "type": "string"
      },
      "iswcMetadata": {
        "allOf": [
          {
            "properties": {
              "createdDate": {
                "type": "string",
                "description": "Data and time of creation in the system",
                "format": "date-time"
              },
              "lastModifiedDate": {
                "type": "string",
                "description": "Data and time of the latest update in the system",
                "format": "date-time"
              },
              "lastModifiedBy": {
                "type": "string",
                "description": "Identifier of the last update in the system"
              }
            }
          },
          {
            "required": [
              "originalTitle",
              "interestedParties"
            ],
            "properties": {
              "iswc": {
                "pattern": "T[0-9]{10}",
                "type": "string"
              },
              "agency": {
                "maxLength": 3,
                "minLength": 3,
                "type": "string",
                "description": "A CISAC code of a submitting agency that allocated this ISWC"
              },
              "originalTitle": {
                "type": "string",
                "description": "Original title of a musical composition"
              },
              "otherTitles": {
                "type": "array",
                "items": {
                  "required": [
                    "title",
                    "type"
                  ],
                  "type": "object",
                  "properties": {
                    "title": {
                      "type": "string",
                      "description": "Musical work title"
                    },
                    "type": {
                      "enum": [
                        "CT",
                        "OT",
                        "RT",
                        "AT",
                        "ET",
                        "ST",
                        "TO",
                        "OA",
                        "TE",
                        "FT",
                        "IT",
                        "TT",
                        "PT",
                        "OL",
                        "AL"
                      ],
                      "type": "string",
                      "description": "Musical work title type"
                    }
                  }
                },
                "description": "Other titles associated with musical composition (aka alternative titles)"
              },
              "interestedParties": {
                "type": "array",
                "items": {
                  "type": "object",
                  "properties": {
                    "name": {
                      "type": "string"
                    },
                    "lastName": {
                      "type": "string"
                    },
                    "nameNumber": {
                      "type": "integer",
                      "format": "int64"
                    },
                    "baseNumber": {
                      "type": "string"
                    },
                    "affiliation": {
                      "type": "string"
                    },
                    "role": {
                      "enum": [
                        "CA",
                        "AR",
                        "SE",
                        "PA",
                        "ES",
                        "AM",
                        "SA",
                        "C",
                        "AD",
                        "A",
                        "E",
                        "AQ",
                        "SR",
                        "TR",
                        "MA",
                        "TA"
                      ],
                      "type": "string",
                      "description": "The role will be rolled up to the corresponding CISAC Role as per the following mapping: C(C,A,CA), MA(AR,SR), TA(AD,SA,TR) E(E,AM)"
                    },
                    "legalEntityType": {
                      "enum": [
                        "N",
                        "L"
                      ],
                      "type": "string"
                    }
                  }
                },
                "description": "Interested party associated with musical composition, such as :composers, lyricist, translator, original and sub publishers"
              }
            }
          },
          {
            "required": [
              "iswc",
              "agency"
            ],
            "type": "object",
            "properties": {
              "works": {
                "type": "array",
                "items": {
                  "required": [
                    "id",
                    "iswc",
                    "deleted"
                  ],
                  "allOf": [
                    {
                      "required": [
                        "agency",
                        "sourcedb",
                        "workcode",
                        "category",
                        "originalTitle",
                        "interestedParties"
                      ],
                      "allOf": [
                        {
                          "required": [
                            "originalTitle",
                            "interestedParties"
                          ],
                          "properties": {
                            "iswc": {
                              "pattern": "T[0-9]{10}",
                              "type": "string"
                            },
                            "agency": {
                              "maxLength": 3,
                              "minLength": 3,
                              "type": "string",
                              "description": "A CISAC code of a submitting agency that allocated this ISWC"
                            },
                            "originalTitle": {
                              "type": "string",
                              "description": "Original title of a musical composition"
                            },
                            "otherTitles": {
                              "type": "array",
                              "items": {
                                "required": [
                                  "title",
                                  "type"
                                ],
                                "type": "object",
                                "properties": {
                                  "title": {
                                    "type": "string",
                                    "description": "Musical work title"
                                  },
                                  "type": {
                                    "enum": [
                                      "CT",
                                      "OT",
                                      "RT",
                                      "AT",
                                      "ET",
                                      "ST",
                                      "TO",
                                      "OA",
                                      "TE",
                                      "FT",
                                      "IT",
                                      "TT",
                                      "PT",
                                      "OL",
                                      "AL"
                                    ],
                                    "type": "string",
                                    "description": "Musical work title type"
                                  }
                                }
                              },
                              "description": "Other titles associated with musical composition (aka alternative titles)"
                            },
                            "interestedParties": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "name": {
                                    "type": "string"
                                  },
                                  "lastName": {
                                    "type": "string"
                                  },
                                  "nameNumber": {
                                    "type": "integer",
                                    "format": "int64"
                                  },
                                  "baseNumber": {
                                    "type": "string"
                                  },
                                  "affiliation": {
                                    "type": "string"
                                  },
                                  "role": {
                                    "enum": [
                                      "CA",
                                      "AR",
                                      "SE",
                                      "PA",
                                      "ES",
                                      "AM",
                                      "SA",
                                      "C",
                                      "AD",
                                      "A",
                                      "E",
                                      "AQ",
                                      "SR",
                                      "TR",
                                      "MA",
                                      "TA"
                                    ],
                                    "type": "string",
                                    "description": "The role will be rolled up to the corresponding CISAC Role as per the following mapping: C(C,A,CA), MA(AR,SR), TA(AD,SA,TR) E(E,AM)"
                                  },
                                  "legalEntityType": {
                                    "enum": [
                                      "N",
                                      "L"
                                    ],
                                    "type": "string"
                                  }
                                }
                              },
                              "description": "Interested party associated with musical composition, such as :composers, lyricist, translator, original and sub publishers"
                            }
                          }
                        },
                        {
                          "type": "object"
                        }
                      ],
                      "properties": {
                        "agency": {
                          "maxLength": 3,
                          "minLength": 3,
                          "type": "string"
                        },
                        "sourcedb": {
                          "type": "integer",
                          "format": "int32"
                        },
                        "workcode": {
                          "type": "string"
                        },
                        "category": {
                          "enum": [
                            "DOM",
                            "INT"
                          ],
                          "type": "string"
                        },
                        "disambiguation": {
                          "type": "boolean"
                        },
                        "disambiguationReason": {
                          "enum": [
                            "DIT",
                            "DIA",
                            "DIE",
                            "DIC",
                            "DIP",
                            "DIV"
                          ],
                          "type": "string",
                          "description": "Disambiguation Reason Code"
                        },
                        "disambiguateFrom": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "iswc": {
                                "pattern": "T[0-9]{10}",
                                "type": "string"
                              }
                            }
                          }
                        },
                        "bvltr": {
                          "enum": [
                            "Background",
                            "Logo",
                            "Theme",
                            "Visual",
                            "RolledUpCue"
                          ],
                          "type": "string",
                          "description": "Background, Logo, Theme, Visual or Rolled Up Cue"
                        },
                        "derivedWorkType": {
                          "enum": [
                            "ModifiedVersion",
                            "Excerpt",
                            "Composite"
                          ],
                          "type": "string",
                          "description": "Derived Work Type- if not provided then this isn't a derived work"
                        },
                        "derivedFromIswcs": {
                          "type": "array",
                          "items": {
                            "type": "object",
                            "properties": {
                              "iswc": {
                                "pattern": "T[0-9]{10}",
                                "type": "string"
                              },
                              "title": {
                                "type": "string"
                              }
                            }
                          }
                        },
                        "performers": {
                          "type": "array",
                          "items": {
                            "required": [
                              "lastName"
                            ],
                            "type": "object",
                            "properties": {
                              "firstName": {
                                "maxLength": 50,
                                "minLength": 1,
                                "type": "string"
                              },
                              "lastName": {
                                "maxLength": 50,
                                "minLength": 1,
                                "type": "string"
                              }
                            }
                          }
                        },
                        "instrumentation": {
                          "type": "array",
                          "items": {
                            "required": [
                              "code"
                            ],
                            "type": "object",
                            "properties": {
                              "code": {
                                "maxLength": 3,
                                "minLength": 1,
                                "type": "string"
                              }
                            }
                          }
                        },
                        "cisnetCreatedDate": {
                          "type": "string",
                          "description": "Date and time when this metadata was created on CISNET",
                          "format": "date-time"
                        },
                        "cisnetLastModifiedDate": {
                          "type": "string",
                          "description": "Date and time when this metadata last modified on CISNET",
                          "format": "date-time"
                        },
                        "additionalIdentifiers": {
                          "type": "object",
                          "properties": {
                            "isrcs": {
                              "type": "array",
                              "items": {
                                "type": "string"
                              }
                            },
                            "publisherIdentifiers": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "nameNumber": {
                                    "type": "integer",
                                    "format": "int64"
                                  },
                                  "submitterCode": {
                                    "type": "string"
                                  },
                                  "workCode": {
                                    "type": "array",
                                    "items": {
                                      "type": "string"
                                    }
                                  }
                                }
                              }
                            },
                            "agencyWorkCodes": {
                              "type": "array",
                              "items": {
                                "type": "object",
                                "properties": {
                                  "agency": {
                                    "maxLength": 3,
                                    "minLength": 3,
                                    "type": "string"
                                  },
                                  "workCode": {
                                    "maxLength": 20,
                                    "type": "string"
                                  }
                                }
                              }
                            }
                          },
                          "description": "Optional list of additional identifiers that can be supplied with the submission."
                        }
                      }
                    },
                    {
                      "properties": {
                        "createdDate": {
                          "type": "string",
                          "description": "Data and time of creation in the system",
                          "format": "date-time"
                        },
                        "lastModifiedDate": {
                          "type": "string",
                          "description": "Data and time of the latest update in the system",
                          "format": "date-time"
                        },
                        "lastModifiedBy": {
                          "type": "string",
                          "description": "Identifier of the last update in the system"
                        }
                      }
                    },
                    {
                      "type": "object"
                    }
                  ],
                  "properties": {
                    "id": {
                      "type": "integer",
                      "description": "An unique identifier assigned by the system",
                      "format": "int64"
                    },
                    "iswc": {
                      "description": "A preferred ISWC assigned by the system"
                    },
                    "iswcEligible": {
                      "type": "boolean",
                      "description": "Indicator of a submitter being Iswc Eligible"
                    },
                    "deleted": {
                      "type": "boolean",
                      "description": "Indicator of a submission being logically deleted on CSINET"
                    },
                    "linkedFrom": {
                      "pattern": "T[0-9]{10}",
                      "type": "string",
                      "description": "The ISWC record that this is linked from"
                    },
                    "linkedTo": {
                      "pattern": "T[0-9]{10}",
                      "type": "string",
                      "description": "The ISWC record that this is linked to"
                    },
                    "rejection": {
                      "required": [
                        "code",
                        "message"
                      ],
                      "properties": {
                        "code": {
                          "type": "string"
                        },
                        "message": {
                          "type": "string"
                        }
                      }
                    },
                    "archivedIswc": {
                      "pattern": "T[0-9]{10}",
                      "type": "string",
                      "description": "The Archived ISWC"
                    },
                    "overallParentISWC": {
                      "pattern": "T[0-9]{10}",
                      "type": "string",
                      "description": "The preferred ISWC that is at the top of the chain of ISWCs."
                    }
                  }
                }
              },
              "parentISWC": {
                "pattern": "T[0-9]{10}",
                "type": "string",
                "description": "A preferred ISWC of a parent of this ISWC. Presence of this field indicates that the ISWC merged to the parent."
              },
              "linkedISWC": {
                "type": "array",
                "items": {
                  "pattern": "T[0-9]{10}",
                  "type": "string"
                },
                "description": "All linked preferred ISWCs. Presence of this field indicates that those ISWCs merged to this ISWC."
              },
              "overallParentISWC": {
                "pattern": "T[0-9]{10}",
                "type": "string",
                "description": "The preferred ISWC that is at the top of the chain of ISWCs."
              }
            },
            "xml": {
              "name": "ISWCMetadata"
            }
          }
        ]
      },
      "rejection": {
        "required": [
          "code",
          "message"
        ],
        "properties": {
          "code": {
            "type": "string"
          },
          "message": {
            "type": "string"
          }
        }
      },
      "workflowMessage": {
        "maxLength": 200,
        "type": "string",
        "description": "The reason for the workflow update"
      }
    }
  },
  "xml": {
    "name": "Batch",
    "wrapped": true
  },
  "x-apim-inline": true
}

400 Bad Request

Bad Request

401 Unauthorized

Not Authorized

404 Not Found

Workflow Task not found

Code samples

@ECHO OFF

curl -v -X PATCH "https://cisaciswcuat.azure-api.net/iswc/workflowTasks?agency={agency}"
-H "Content-Type: application/json"
-H "Ocp-Apim-Subscription-Key: {subscription key}"

--data-ascii "{body}" 
using System;
using System.Net.Http.Headers;
using System.Text;
using System.Net.Http;
using System.Web;

namespace CSHttpClientSample
{
    static class Program
    {
        static void Main()
        {
            MakeRequest();
            Console.WriteLine("Hit ENTER to exit...");
            Console.ReadLine();
        }
        
        static async void MakeRequest()
        {
            var client = new HttpClient();
            var queryString = HttpUtility.ParseQueryString(string.Empty);

            // Request headers
            client.DefaultRequestHeaders.Add("Ocp-Apim-Subscription-Key", "{subscription key}");

            var uri = "https://cisaciswcuat.azure-api.net/iswc/workflowTasks?agency={agency}&" + queryString;

        }
    }
}	
// // This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
import java.net.URI;
import org.apache.http.HttpEntity;
import org.apache.http.HttpResponse;
import org.apache.http.client.HttpClient;
import org.apache.http.client.methods.HttpGet;
import org.apache.http.client.utils.URIBuilder;
import org.apache.http.impl.client.HttpClients;
import org.apache.http.util.EntityUtils;

public class JavaSample 
{
    public static void main(String[] args) 
    {
        HttpClient httpclient = HttpClients.createDefault();

        try
        {
            URIBuilder builder = new URIBuilder("https://cisaciswcuat.azure-api.net/iswc/workflowTasks?agency={agency}");


            URI uri = builder.build();
            HttpPatch request = new HttpPatch(uri);
            request.setHeader("Content-Type", "application/json");
            request.setHeader("Ocp-Apim-Subscription-Key", "{subscription key}");


            // Request body
            StringEntity reqEntity = new StringEntity("{body}");
            request.setEntity(reqEntity);

            HttpResponse response = httpclient.execute(request);
            HttpEntity entity = response.getEntity();

            if (entity != null) 
            {
                System.out.println(EntityUtils.toString(entity));
            }
        }
        catch (Exception e)
        {
            System.out.println(e.getMessage());
        }
    }
}

<!DOCTYPE html>
<html>
<head>
    <title>JSSample</title>
    <script src="http://ajax.googleapis.com/ajax/libs/jquery/1.9.0/jquery.min.js"></script>
</head>
<body>

<script type="text/javascript">
    $(function() {
        var params = {
            // Request parameters
        };
      
        $.ajax({
            url: "https://cisaciswcuat.azure-api.net/iswc/workflowTasks?agency={agency}&" + $.param(params),
            beforeSend: function(xhrObj){
                // Request headers
                xhrObj.setRequestHeader("Content-Type","application/json");
                xhrObj.setRequestHeader("Ocp-Apim-Subscription-Key","{subscription key}");
            },
            type: "PATCH",
            // Request body
            data: "{body}",
        })
        .done(function(data) {
            alert("success");
        })
        .fail(function() {
            alert("error");
        });
    });
</script>
</body>
</html>
#import <Foundation/Foundation.h>

int main(int argc, const char * argv[])
{
    NSAutoreleasePool * pool = [[NSAutoreleasePool alloc] init];
    
    NSString* path = @"https://cisaciswcuat.azure-api.net/iswc/workflowTasks?agency={agency}";
    NSArray* array = @[
                         // Request parameters
                         @"entities=true",
                      ];
    
    NSString* string = [array componentsJoinedByString:@"&"];
    path = [path stringByAppendingFormat:@"?%@", string];

    NSLog(@"%@", path);

    NSMutableURLRequest* _request = [NSMutableURLRequest requestWithURL:[NSURL URLWithString:path]];
    [_request setHTTPMethod:@"PATCH"];
    // Request headers
    [_request setValue:@"application/json" forHTTPHeaderField:@"Content-Type"];
    [_request setValue:@"{subscription key}" forHTTPHeaderField:@"Ocp-Apim-Subscription-Key"];
    // Request body
    [_request setHTTPBody:[@"{body}" dataUsingEncoding:NSUTF8StringEncoding]];
    
    NSURLResponse *response = nil;
    NSError *error = nil;
    NSData* _connectionData = [NSURLConnection sendSynchronousRequest:_request returningResponse:&response error:&error];

    if (nil != error)
    {
        NSLog(@"Error: %@", error);
    }
    else
    {
        NSError* error = nil;
        NSMutableDictionary* json = nil;
        NSString* dataString = [[NSString alloc] initWithData:_connectionData encoding:NSUTF8StringEncoding];
        NSLog(@"%@", dataString);
        
        if (nil != _connectionData)
        {
            json = [NSJSONSerialization JSONObjectWithData:_connectionData options:NSJSONReadingMutableContainers error:&error];
        }
        
        if (error || !json)
        {
            NSLog(@"Could not parse loaded json with error:%@", error);
        }
        
        NSLog(@"%@", json);
        _connectionData = nil;
    }
    
    [pool drain];

    return 0;
}
<?php
// This sample uses the Apache HTTP client from HTTP Components (http://hc.apache.org/httpcomponents-client-ga/)
require_once 'HTTP/Request2.php';

$request = new Http_Request2('https://cisaciswcuat.azure-api.net/iswc/workflowTasks?agency={agency}');
$url = $request->getUrl();

$headers = array(
    // Request headers
    'Content-Type' => 'application/json',
    'Ocp-Apim-Subscription-Key' => '{subscription key}',
);

$request->setHeader($headers);

$parameters = array(
    // Request parameters
);

$url->setQueryVariables($parameters);

$request->setMethod(HTTP_Request2::METHOD_PATCH);

// Request body
$request->setBody("{body}");

try
{
    $response = $request->send();
    echo $response->getBody();
}
catch (HttpException $ex)
{
    echo $ex;
}

?>
########### Python 2.7 #############
import httplib, urllib, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.urlencode({
})

try:
    conn = httplib.HTTPSConnection('cisaciswcuat.azure-api.net')
    conn.request("PATCH", "/iswc/workflowTasks?agency={agency}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################

########### Python 3.2 #############
import http.client, urllib.request, urllib.parse, urllib.error, base64

headers = {
    # Request headers
    'Content-Type': 'application/json',
    'Ocp-Apim-Subscription-Key': '{subscription key}',
}

params = urllib.parse.urlencode({
})

try:
    conn = http.client.HTTPSConnection('cisaciswcuat.azure-api.net')
    conn.request("PATCH", "/iswc/workflowTasks?agency={agency}&%s" % params, "{body}", headers)
    response = conn.getresponse()
    data = response.read()
    print(data)
    conn.close()
except Exception as e:
    print("[Errno {0}] {1}".format(e.errno, e.strerror))

####################################
require 'net/http'

uri = URI('https://cisaciswcuat.azure-api.net/iswc/workflowTasks?agency={agency}')


request = Net::HTTP::Patch.new(uri.request_uri)
# Request headers
request['Content-Type'] = 'application/json'
# Request headers
request['Ocp-Apim-Subscription-Key'] = '{subscription key}'
# Request body
request.body = "{body}"

response = Net::HTTP.start(uri.host, uri.port, :use_ssl => uri.scheme == 'https') do |http|
    http.request(request)
end

puts response.body