Jump to

• Request
• Response

Update an activity

patch

/fscmRestApi/resources/11.13.18.05/publicSectorActivities/{publicSectorActivitiesUniqID}

Request

Supported Media Types

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

Path Parameters

• publicSectorActivitiesUniqID: integer
  This is the hash key of the attributes which make up the composite key--- ActivityId, AgencyId and Classification ---for the Activities resource and used to uniquely identify an instance of Activities. The client should not generate the hash key value. Instead, the client should query on the Activities collection resource with a filter on the primary key values in order to navigate to a specific instance of Activities.
  
  For example: publicSectorActivities?q=ActivityId=<value1>;AgencyId=<value2>;Classification=<value3>

Body ()

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

Root Schema : publicSectorActivities-item

Type: object

Show Source

• ActivityId(optional): string
  Maximum Length: 50

  The unique identifier of the activity.
• ActivityName(optional): string
  Maximum Length: 250

  The activity name.
• AgencyId(optional): integer(int32)
  The unique identifier of the agency associated with this activity.
• Classification(optional): string
  Maximum Length: 50

  The applicable offering for the activity.
• Description(optional): string
  Maximum Length: 1000

  The activity description.
• EnabledFlag(optional): boolean
  Indicates whether the activity is enabled for use. Valid values are Y for enabled activity and N for disabled activity.
• links(optional): array Items
  Title: Items

  Link Relations
• ObjectVersionNumber(optional): integer(int32)
  The object version number used to implement optimistic locking. It is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.

{
    "properties":{
        "ActivityId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the activity."
        },
        "ActivityName":{
            "maxLength":250,
            "type":"string",
            "description":"The activity name."
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with this activity."
        },
        "Classification":{
            "maxLength":50,
            "type":"string",
            "description":"The applicable offering for the activity."
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The activity description."
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the activity is enabled for use. Valid values are Y for enabled activity and N for disabled activity."
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"The object version number used to implement optimistic locking. It is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried."
        },
        "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 : publicSectorActivities-item

Type: object

Show Source

• ActivityId(optional): string
  Maximum Length: 50

  The unique identifier of the activity.
• ActivityName(optional): string
  Maximum Length: 250

  The activity name.
• AgencyId(optional): integer(int32)
  The unique identifier of the agency associated with this activity.
• Classification(optional): string
  Maximum Length: 50

  The applicable offering for the activity.
• Description(optional): string
  Maximum Length: 1000

  The activity description.
• EnabledFlag(optional): boolean
  Indicates whether the activity is enabled for use. Valid values are Y for enabled activity and N for disabled activity.
• links(optional): array Items
  Title: Items

  Link Relations
• ObjectVersionNumber(optional): integer(int32)
  The object version number used to implement optimistic locking. It is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried.

{
    "properties":{
        "ActivityId":{
            "maxLength":50,
            "type":"string",
            "description":"The unique identifier of the activity."
        },
        "ActivityName":{
            "maxLength":250,
            "type":"string",
            "description":"The activity name."
        },
        "AgencyId":{
            "format":"int32",
            "type":"integer",
            "description":"The unique identifier of the agency associated with this activity."
        },
        "Classification":{
            "maxLength":50,
            "type":"string",
            "description":"The applicable offering for the activity."
        },
        "Description":{
            "maxLength":1000,
            "type":"string",
            "description":"The activity description."
        },
        "EnabledFlag":{
            "type":"boolean",
            "description":"Indicates whether the activity is enabled for use. Valid values are Y for enabled activity and N for disabled activity."
        },
        "ObjectVersionNumber":{
            "format":"int32",
            "type":"integer",
            "description":"The object version number used to implement optimistic locking. It is incremented every time that the row is updated. The number is compared at the start and end of a transaction to detect whether another session has updated the row since it was queried."
        },
        "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