YellowHammer

Perform various operations for Symitar parameters.

Symitar eDocs References: Coming soon.

Operations

getYellowHammer

post

Get yellow hammer

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getYellowHammer

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getYellowHammer HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 124

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "YellowHammer": {
    "Description": [
      {
        "EntryId": 1,
        "Description": "text"
      }
    ],
    "Enabled": true,
    "ErrorMessage": "text",
    "ExemptServiceCode": 1,
    "Privilege": [
      {
        "EntryId": 1,
        "Privilege": 1
      }
    ],
    "RuleId": [
      {
        "EntryId": 1,
        "RuleId": 1
      }
    ],
    "Warning": [
      {
        "EntryId": 1,
        "Warning": true
      }
    ]
  }
}

getYellowHammerSelectFields

post

Get yellow hammer select fields

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/getYellowHammerSelectFields

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/getYellowHammerSelectFields HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 325

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "SelectableFields": {
    "IncludeAllYellowHammerFields": true,
    "YellowHammerFields": {
      "Description": [
        1
      ],
      "Enabled": true,
      "ErrorMessage": true,
      "ExemptServiceCode": true,
      "Privilege": [
        1
      ],
      "RuleId": [
        1
      ],
      "Warning": [
        1
      ]
    }
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "YellowHammer": {
    "Description": [
      {
        "EntryId": 1,
        "Description": "text"
      }
    ],
    "Enabled": true,
    "ErrorMessage": "text",
    "ExemptServiceCode": 1,
    "Privilege": [
      {
        "EntryId": 1,
        "Privilege": 1
      }
    ],
    "RuleId": [
      {
        "EntryId": 1,
        "RuleId": 1
      }
    ],
    "Warning": [
      {
        "EntryId": 1,
        "Warning": true
      }
    ]
  }
}

updateYellowHammerByID

post

Update Yellow Hammer for a specific ID.

Authorizations

bearerAuth

AuthorizationstringRequired

Bearer authentication header of the form Bearer <token>.

Body

application/json

Responses

200

Successful operation.

application/json

post

/updateYellowHammerByID

HTTPcURLJavaScriptPython

POST /nexum/627/2022.01/parameter/updateYellowHammerByID HTTP/1.1
Host: naas.ymcu.libum.io
Authorization: Bearer YOUR_SECRET_TOKEN
Content-Type: application/json
Accept: */*
Content-Length: 370

{
  "Credentials": {
    "AdministrativeCredentials": {
      "Password": "suwn37834b91&"
    }
  },
  "YellowHammerUpdatableFields": {
    "Description": [
      {
        "EntryId": 1,
        "Description": "text"
      }
    ],
    "ErrorMessage": "text",
    "ExemptServiceCode": 1,
    "Privilege": [
      {
        "EntryId": 1,
        "Privilege": 1
      }
    ],
    "RuleId": [
      {
        "EntryId": 1,
        "RuleId": 1
      }
    ],
    "Warning": [
      {
        "EntryId": 1,
        "Warning": true
      }
    ]
  },
  "nxAttributes": {
    "customFields": {
      "appId": "glaci"
    }
  }
}

200

Successful operation.

{
  "UpdateStatus": {
    "isAllFieldsUpdateSuccess": true,
    "FailedUpdateStatus": [
      {
        "Record": "text",
        "ErrorCode": "text",
        "ErrorMessage": "text",
        "PrimaryKeyField": [
          {
            "Name": "text",
            "Value": "text"
          }
        ]
      }
    ]
  }
}