Jump to

• Request
• Response

Update a business entity

patch

/fscmRestApi/resources/11.13.18.05/publicSectorBusEntityStatuses/{publicSectorBusEntityStatusesUniqID}

Request

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Path Parameters

• publicSectorBusEntityStatusesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- BusinessEntityKey and BusinessEntityId ---for the Bus Entity Statuses resource and used to uniquely identify an instance of Bus Entity Statuses. The client should not generate the hash key value. Instead, the client should query on the Bus Entity Statuses collection resource with a filter on the primary key values in order to navigate to a specific instance of Bus Entity Statuses.
  
  For example: publicSectorBusEntityStatuses?q=BusinessEntityKey=<value1>;BusinessEntityId=<value2>

Body ()

The following table describes the body parameters in the request for this task.

Root Schema : publicSectorBusEntityStatuses-item

Type: object

Show Source

• BusinessEntityId(optional): string
  Maximum Length: 50

  The unique identifier for a business entity.
• BusinessEntityKey(optional): integer(int64)
  System generated unique identifier for a business entity.
• BusStatus(optional): string
  Maximum Length: 20

  Current status of the business entity.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "BusStatus":{
            "maxLength":20,
            "type":"string",
            "description":"Current status of the business entity."
        },
        "BusinessEntityId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a business entity."
        },
        "BusinessEntityKey":{
            "format":"int64",
            "type":"integer",
            "description":"System generated unique identifier for a business entity."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top

Response

Supported Media Types

• application/vnd.oracle.adf.resourceitem+json
• application/json

Default Response

The following table describes the default response for this task.

Body ()

Root Schema : publicSectorBusEntityStatuses-item

Type: object

Show Source

• BusinessEntityId(optional): string
  Maximum Length: 50

  The unique identifier for a business entity.
• BusinessEntityKey(optional): integer(int64)
  System generated unique identifier for a business entity.
• BusStatus(optional): string
  Maximum Length: 20

  Current status of the business entity.
• links(optional): array Items
  Title: Items

  Link Relations

{
    "properties":{
        "BusStatus":{
            "maxLength":20,
            "type":"string",
            "description":"Current status of the business entity."
        },
        "BusinessEntityId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier for a business entity."
        },
        "BusinessEntityKey":{
            "format":"int64",
            "type":"integer",
            "description":"System generated unique identifier for a business entity."
        },
        "links":{
            "items":{
                "$ref":"#/definitions/link"
            },
            "type":"array",
            "description":"Link Relations",
            "title":"Items"
        }
    },
    "type":"object"
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

{
    "items":{
        "$ref":"#/definitions/link"
    },
    "type":"array",
    "description":"Link Relations",
    "title":"Items"
}

Nested Schema : link

Type: object

Show Source

• href(optional): string
  Title: hyperlink reference

  The URI to the related resource.
• rel(optional): string
  Title: relation

  The name of the relation to the resource instance. Example: self.

{
    "properties":{
        "href":{
            "type":"string",
            "description":"The URI to the related resource.",
            "title":"hyperlink reference"
        },
        "rel":{
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "title":"relation"
        }
    },
    "type":"object"
}

Back to Top