Jump to

• Request
• Response

Get Agreement State Map

get

/agreements/lifecyclestates

Gets agreement status and lifecycle-status mappings

Request

There are no request parameters for this operation.

There's no request body for this operation.

Back to Top

Response

Supported Media Types

• application/xml
• application/json

200 Response

The agreement state map was returned successfully.

Body ()

Root Schema : agreementStateMap

Type: object

Show Source

• extension: object extension
  The extended attributes.
• statuses: array statuses

{
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "statuses":{
            "type":"array",
            "items":{
                "$ref":"#/components/schemas/AgreementState"
            }
        }
    },
    "xml":{
        "name":"agreementStateMap",
        "namespace":"http://xmlns.oracle.com/cgbu/schemas/BusinessObjs"
    }
}

Nested Schema : extension

Type: object

The extended attributes.

Nested Schema : statuses

Type: array

Show Source

• Array of: object AgreementState

{
    "type":"array",
    "items":{
        "$ref":"#/components/schemas/AgreementState"
    }
}

Nested Schema : AgreementState

Type: object

Show Source

• extension: object extension
  The extended attributes.
• stateId: integer (int32)
• stateName(required): string
• status: integer (int32)
• stringId: integer (int32)
• strVersion: integer (int32)

{
    "required":[
        "stateName"
    ],
    "type":"object",
    "properties":{
        "extension":{
            "type":"object",
            "description":"The extended attributes."
        },
        "stateId":{
            "type":"integer",
            "format":"int32"
        },
        "stateName":{
            "type":"string"
        },
        "status":{
            "type":"integer",
            "format":"int32"
        },
        "stringId":{
            "type":"integer",
            "format":"int32"
        },
        "strVersion":{
            "type":"integer",
            "format":"int32"
        }
    }
}

Nested Schema : extension

Type: object

The extended attributes.

500 Response

An internal server error occurred.

Back to Top