Playbook Assembly Reference Category Conditions

Get a paginated list of category conditions for a condition.

get

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

conditionObjectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

assemblyObjectIdentifierstringRequired

referenceObjectIdentifierstringRequired

Query parameters

pageinteger · int32OptionalDefault: 1

pageSizeinteger · int32OptionalDefault: 20

Responses

200

OK

totalCountinteger · int32Optional

400

Bad Request

403

Forbidden

get/playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions/{conditionObjectIdentifier}/category-conditions

GET /playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions/{conditionObjectIdentifier}/category-conditions HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "items": [
    {
      "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "assemblyReferenceConditionObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
      "fuzzyMatch": true,
      "text": "text"
    }
  ],
  "totalCount": 1
}

Create a new category condition for an assembly reference condition.

post

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

conditionObjectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

assemblyObjectIdentifierstringRequired

referenceObjectIdentifierstringRequired

Body

fuzzyMatchbooleanOptional

textstring · nullableRequired

Responses

201

Created

objectIdentifierstring · uuidOptional

assemblyReferenceConditionObjectIdentifierstring · uuidOptional

fuzzyMatchbooleanOptional

textstring · nullableOptional

400

Bad Request

403

Forbidden

post/playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions/{conditionObjectIdentifier}/category-conditions

POST /playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions/{conditionObjectIdentifier}/category-conditions HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "fuzzyMatch": true,
  "text": "text"
}

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "assemblyReferenceConditionObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "fuzzyMatch": true,
  "text": "text"
}

Get a specific category condition by object identifier.

get

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

assemblyObjectIdentifierstringRequired

referenceObjectIdentifierstringRequired

conditionObjectIdentifierstringRequired

Responses

200

OK

objectIdentifierstring · uuidOptional

assemblyReferenceConditionObjectIdentifierstring · uuidOptional

fuzzyMatchbooleanOptional

textstring · nullableOptional

403

Forbidden

404

Not Found

get/playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions/{conditionObjectIdentifier}/category-conditions/{objectIdentifier}

GET /playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions/{conditionObjectIdentifier}/category-conditions/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "assemblyReferenceConditionObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "fuzzyMatch": true,
  "text": "text"
}

Update an existing category condition.

put

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

assemblyObjectIdentifierstringRequired

referenceObjectIdentifierstringRequired

conditionObjectIdentifierstringRequired

Body

fuzzyMatchbooleanOptional

textstring · nullableRequired

Responses

200

OK

objectIdentifierstring · uuidOptional

assemblyReferenceConditionObjectIdentifierstring · uuidOptional

fuzzyMatchbooleanOptional

textstring · nullableOptional

400

Bad Request

403

Forbidden

404

Not Found

put/playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions/{conditionObjectIdentifier}/category-conditions/{objectIdentifier}

PUT /playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions/{conditionObjectIdentifier}/category-conditions/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 33

{
  "fuzzyMatch": true,
  "text": "text"
}

{
  "objectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "assemblyReferenceConditionObjectIdentifier": "123e4567-e89b-12d3-a456-426614174000",
  "fuzzyMatch": true,
  "text": "text"
}

Delete a category condition from a condition.

delete

Authorizations

AuthorizationstringRequired

Bearer authentication with JWT

Path parameters

objectIdentifierstring · uuidRequired

playbookIdentifierstringRequired

assemblyObjectIdentifierstringRequired

referenceObjectIdentifierstringRequired

conditionObjectIdentifierstringRequired

Responses

204

No Content

No content

403

Forbidden

404

Not Found

delete/playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions/{conditionObjectIdentifier}/category-conditions/{objectIdentifier}

DELETE /playbooks/{playbookIdentifier}/assemblies/{assemblyObjectIdentifier}/references/{referenceObjectIdentifier}/conditions/{conditionObjectIdentifier}/category-conditions/{objectIdentifier} HTTP/1.1
Host: api.example.uk.jylo.ai
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

No content