Jump to

• Request
• Response

Update an activity status

patch

/fscmRestApi/resources/11.13.18.05/publicSectorActivityStatuses/{publicSectorActivityStatusesUniqID}

Request

Supported Media Types

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

Path Parameters

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

Body ()

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

Root Schema : publicSectorActivityStatuses-item

Type: object

Show Source

• ActivityStatus(optional): string
  Title: Activity Status

  Maximum Length: 15

  The status of the activity.
• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with this activity.
• Classification(optional): string
  Title: Classification

  Maximum Length: 3

  The classification type for the record status.
• CreationDate(optional): string(date-time)
  The date and time when the activity status was created.
• DeletedFlag(optional): string
  Title: Deleted

  Maximum Length: 1

  Indicates whether the record is logically deleted. Valid values are Y for a deleted record, and N for an active record.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the activity status.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the activity status is enabled for use. Valid values are Y for enabled activity status and N for disabled activity status.
• LastUpdateDate(optional): string(date-time)
  The date and time when the status was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• ModuleId(optional): string
  Maximum Length: 32

  The Seed Data Framework module that owns the row. A module is an entry in application taxonomy such as a logical business area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data.
• 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.
• SeedDataLock(optional): integer(int32)
  Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.
• SeedDataSource(optional): string
  Maximum Length: 512

  The source of the seed data record. A value of BULK_SEED_DATA_SCRIPT indicates that record was bulk loaded. Otherwise, specifies the name of the seed data file.
• SystemStatus(optional): string
  Title: System Status

  Maximum Length: 15

  The system status.
• SystemUse(optional): boolean
  Title: System Use

  The system use.

{
    "type":"object",
    "properties":{
        "ActivityStatus":{
            "title":"Activity Status",
            "description":"The status of the activity.",
            "type":"string",
            "maxLength":15
        },
        "AgencyId":{
            "title":"Agency ID",
            "description":"The unique identifier of the agency associated with this activity.",
            "type":"integer",
            "format":"int32"
        },
        "Classification":{
            "title":"Classification",
            "description":"The classification type for the record status.",
            "type":"string",
            "maxLength":3
        },
        "CreationDate":{
            "description":"The date and time when the activity status was created.",
            "type":"string",
            "format":"date-time"
        },
        "DeletedFlag":{
            "title":"Deleted",
            "description":"Indicates whether the record is logically deleted. Valid values are Y for a deleted record, and N for an active record.",
            "type":"string",
            "maxLength":1
        },
        "Description":{
            "title":"Description",
            "description":"The description of the activity status.",
            "type":"string",
            "maxLength":100
        },
        "EnabledFlag":{
            "title":"Enabled",
            "description":"Indicates whether the activity status is enabled for use. Valid values are Y for enabled activity status and N for disabled activity status.",
            "type":"boolean"
        },
        "LastUpdateDate":{
            "description":"The date and time when the status was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "ModuleId":{
            "description":"The Seed Data Framework module that owns the row. A module is an entry in application taxonomy such as a logical business area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data.",
            "type":"string",
            "maxLength":32
        },
        "ObjectVersionNumber":{
            "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.",
            "type":"integer",
            "format":"int32"
        },
        "SeedDataLock":{
            "description":"Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.",
            "type":"integer",
            "format":"int32"
        },
        "SeedDataSource":{
            "description":"The source of the seed data record. A value of BULK_SEED_DATA_SCRIPT indicates that record was bulk loaded. Otherwise, specifies the name of the seed data file.",
            "type":"string",
            "maxLength":512
        },
        "SystemStatus":{
            "title":"System Status",
            "description":"The system status.",
            "type":"string",
            "maxLength":15
        },
        "SystemUse":{
            "title":"System Use",
            "description":"The system use.",
            "type":"boolean"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

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 : publicSectorActivityStatuses-item

Type: object

Show Source

• ActivityStatus(optional): string
  Title: Activity Status

  Maximum Length: 15

  The status of the activity.
• AgencyId(optional): integer(int32)
  Title: Agency ID

  The unique identifier of the agency associated with this activity.
• Classification(optional): string
  Title: Classification

  Maximum Length: 3

  The classification type for the record status.
• CreationDate(optional): string(date-time)
  The date and time when the activity status was created.
• DeletedFlag(optional): string
  Title: Deleted

  Maximum Length: 1

  Indicates whether the record is logically deleted. Valid values are Y for a deleted record, and N for an active record.
• Description(optional): string
  Title: Description

  Maximum Length: 100

  The description of the activity status.
• EnabledFlag(optional): boolean
  Title: Enabled

  Indicates whether the activity status is enabled for use. Valid values are Y for enabled activity status and N for disabled activity status.
• LastUpdateDate(optional): string(date-time)
  The date and time when the status was last updated.
• links(optional): array Items
  Title: Items

  Link Relations
• ModuleId(optional): string
  Maximum Length: 32

  The Seed Data Framework module that owns the row. A module is an entry in application taxonomy such as a logical business area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data.
• 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.
• SeedDataLock(optional): integer(int32)
  Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.
• SeedDataSource(optional): string
  Maximum Length: 512

  The source of the seed data record. A value of BULK_SEED_DATA_SCRIPT indicates that record was bulk loaded. Otherwise, specifies the name of the seed data file.
• SystemStatus(optional): string
  Title: System Status

  Maximum Length: 15

  The system status.
• SystemUse(optional): boolean
  Title: System Use

  The system use.

{
    "type":"object",
    "properties":{
        "ActivityStatus":{
            "title":"Activity Status",
            "description":"The status of the activity.",
            "type":"string",
            "maxLength":15
        },
        "AgencyId":{
            "title":"Agency ID",
            "description":"The unique identifier of the agency associated with this activity.",
            "type":"integer",
            "format":"int32"
        },
        "Classification":{
            "title":"Classification",
            "description":"The classification type for the record status.",
            "type":"string",
            "maxLength":3
        },
        "CreationDate":{
            "description":"The date and time when the activity status was created.",
            "type":"string",
            "format":"date-time"
        },
        "DeletedFlag":{
            "title":"Deleted",
            "description":"Indicates whether the record is logically deleted. Valid values are Y for a deleted record, and N for an active record.",
            "type":"string",
            "maxLength":1
        },
        "Description":{
            "title":"Description",
            "description":"The description of the activity status.",
            "type":"string",
            "maxLength":100
        },
        "EnabledFlag":{
            "title":"Enabled",
            "description":"Indicates whether the activity status is enabled for use. Valid values are Y for enabled activity status and N for disabled activity status.",
            "type":"boolean"
        },
        "LastUpdateDate":{
            "description":"The date and time when the status was last updated.",
            "type":"string",
            "format":"date-time"
        },
        "ModuleId":{
            "description":"The Seed Data Framework module that owns the row. A module is an entry in application taxonomy such as a logical business area. When the MODULE_ID column exists and the owner of the row is not specified, then the Seed Data Framework will not extract the row as seed data.",
            "type":"string",
            "maxLength":32
        },
        "ObjectVersionNumber":{
            "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.",
            "type":"integer",
            "format":"int32"
        },
        "SeedDataLock":{
            "description":"Indicates whether the row is seed data. Valid values are 0 for data that is customer data, 1 for seed data that cannot be modified, and 2 for seed data that can be modified.",
            "type":"integer",
            "format":"int32"
        },
        "SeedDataSource":{
            "description":"The source of the seed data record. A value of BULK_SEED_DATA_SCRIPT indicates that record was bulk loaded. Otherwise, specifies the name of the seed data file.",
            "type":"string",
            "maxLength":512
        },
        "SystemStatus":{
            "title":"System Status",
            "description":"The system status.",
            "type":"string",
            "maxLength":15
        },
        "SystemUse":{
            "title":"System Use",
            "description":"The system use.",
            "type":"boolean"
        },
        "links":{
            "title":"Items",
            "description":"Link Relations",
            "type":"array",
            "items":{
                "$ref":"#/definitions/link"
            }
        }
    }
}

Nested Schema : Items

Type: array

Title: Items

Link Relations

Show Source

• Array of: object link

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

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.

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

Back to Top