Jump to

• Request
• Response
• Examples

Update a data access security

patch

/fscmRestApi/resources/11.13.18.05/collaborationPlanners/{PersonId}/child/dataAccessSecurity/{dataAccessSecurityUniqID}

Request

Path Parameters

• PersonId(required): integer(int64)
  The value of this parameter could be a hash of the key that is used to uniquely identify the resource item. The client should not generate the hash key value. Instead, the client should query on the collection resource with a filter to navigate to a specific resource item. For example: products?q=InventoryItemId=
• dataAccessSecurityUniqID(required): string
  This is the hash key of the attributes which make up the composite key for the Data Access Security resource and used to uniquely identify an instance of Data Access Security. The client should not generate the hash key value. Instead, the client should query on the Data Access Security collection resource in order to navigate to a specific instance of Data Access Security to get the hash key.

Header Parameters

• Metadata-Context:
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version:
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Supported Media Types

• application/json

Request Body - application/json ()

Root Schema : schema

Type: object

Show Source

• OrganizationCode: string
  Abbreviation that identifies the organization that receives the item.
• OrganizationId: string
  Value that uniquely identifies the organization. This organization receives the shipment. It's a primary key that the application creates when it creates an organization.
• OrganizationName: string
  Name of the organization that receives the item.
• ProcurementBUId: integer
  Value that uniquely identifies the procurement business unit. It's a primary key that the application creates when it creates the business unit.
• ProcurementBUName: string
  Name of the business unit. The application assigns the supplier site to this business unit.
• SecurityContext: string
  Value that identifies the level of security applied. Values include supplier or supplier site.
• SecurityContextCode: string
  Value that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.
• ShipFromSupplierId: integer
  Value that uniquely identifies the supplier who ships the item. It's a primary key that the application creates when it creates the supplier.
• ShipFromSupplierName: string
  Name of the supplier that ships the item.
• ShipFromSupplierSiteId: integer
  Value that uniquely identifies the supplier site who ships the item. It's a primary key that the application creates when it creates the supplier site.
• ShipFromSupplierSiteName: string
  Name of the supplier site that ships the item.
• SourceSystem: string
  Value that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include External or Oracle.
• SourceSystemCode: string
  Abbreviation that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.

{
    "type":"object",
    "properties":{
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit. It's a primary key that the application creates when it creates the business unit.",
            "nullable":true
        },
        "OrganizationName":{
            "type":"string",
            "description":"Name of the organization that receives the item.",
            "nullable":true,
            "x-queryable":false
        },
        "OrganizationId":{
            "type":"string",
            "description":"Value that uniquely identifies the organization. This organization receives the shipment. It's a primary key that the application creates when it creates an organization.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipFromSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site who ships the item. It's a primary key that the application creates when it creates the supplier site.",
            "nullable":true
        },
        "ShipFromSupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who ships the item. It's a primary key that the application creates when it creates the supplier.",
            "nullable":true
        },
        "ShipFromSupplierSiteName":{
            "type":"string",
            "description":"Name of the supplier site that ships the item.",
            "nullable":true
        },
        "SecurityContextCode":{
            "type":"string",
            "description":"Value that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.",
            "nullable":true
        },
        "SecurityContext":{
            "type":"string",
            "description":"Value that identifies the level of security applied. Values include supplier or supplier site.",
            "nullable":true
        },
        "ShipFromSupplierName":{
            "type":"string",
            "description":"Name of the supplier that ships the item.",
            "nullable":true
        },
        "ProcurementBUName":{
            "type":"string",
            "description":"Name of the business unit. The application assigns the supplier site to this business unit.",
            "nullable":true
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the organization that receives the item.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystemCode":{
            "type":"string",
            "description":"Abbreviation that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystem":{
            "type":"string",
            "description":"Value that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include External or Oracle.",
            "nullable":true,
            "x-queryable":false
        }
    }
}

Back to Top

Response

Supported Media Types

• application/json

Default Response

The following table describes the default response for this task.

Headers

• Metadata-Context(required):
  If the REST API supports runtime customizations, the shape of the service may change during runtime. The REST client may isolate itself from these changes or choose to interact with the latest version of the API by specifying this header. For example: Metadata-Context:sandbox="TrackEmployeeFeature".
• REST-Framework-Version(required):
  The protocol version between a REST client and service. If the client does not specify this header in the request the server will pick a default version for the API.

Body ()

Root Schema : collaborationPlanners-dataAccessSecurity-item-response

Type: object

Show Source

• CreatedBy: string
  Read Only: true

  Maximum Length: 64

  User who created the data access security.
• CreationDate: string (date-time)
  Read Only: true

  Date and time when the user created the data access security.
• DataAccessId: integer (int64)
  Read Only: true

  Value that uniquely identifies the data access security of the collaboration planner.
• LastUpdateDate: string (date-time)
  Read Only: true

  Date and time when the user most recently updated the data access security.
• LastUpdatedBy: string
  Read Only: true

  Maximum Length: 64

  User who most recently updated the data access security.
• links: array Links
  Title: Links

  The link relations associated with the resource instance.
• OrganizationCode: string
  Abbreviation that identifies the organization that receives the item.
• OrganizationId: string
  Value that uniquely identifies the organization. This organization receives the shipment. It's a primary key that the application creates when it creates an organization.
• OrganizationName: string
  Name of the organization that receives the item.
• ProcurementBUId: integer
  Value that uniquely identifies the procurement business unit. It's a primary key that the application creates when it creates the business unit.
• ProcurementBUName: string
  Name of the business unit. The application assigns the supplier site to this business unit.
• SecurityContext: string
  Value that identifies the level of security applied. Values include supplier or supplier site.
• SecurityContextCode: string
  Value that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.
• ShipFromSupplierId: integer
  Value that uniquely identifies the supplier who ships the item. It's a primary key that the application creates when it creates the supplier.
• ShipFromSupplierName: string
  Name of the supplier that ships the item.
• ShipFromSupplierSiteId: integer
  Value that uniquely identifies the supplier site who ships the item. It's a primary key that the application creates when it creates the supplier site.
• ShipFromSupplierSiteName: string
  Name of the supplier site that ships the item.
• SourceSystem: string
  Value that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include External or Oracle.
• SourceSystemCode: string
  Abbreviation that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.

{
    "type":"object",
    "properties":{
        "LastUpdatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who most recently updated the data access security.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "ProcurementBUId":{
            "type":"integer",
            "description":"Value that uniquely identifies the procurement business unit. It's a primary key that the application creates when it creates the business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationName":{
            "type":"string",
            "description":"Name of the organization that receives the item.",
            "nullable":true,
            "x-queryable":false
        },
        "CreationDate":{
            "type":"string",
            "description":"Date and time when the user created the data access security.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "CreatedBy":{
            "maxLength":64,
            "type":"string",
            "description":"User who created the data access security.",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        },
        "OrganizationId":{
            "type":"string",
            "description":"Value that uniquely identifies the organization. This organization receives the shipment. It's a primary key that the application creates when it creates an organization.",
            "nullable":true,
            "x-queryable":false
        },
        "ShipFromSupplierSiteId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier site who ships the item. It's a primary key that the application creates when it creates the supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipFromSupplierId":{
            "type":"integer",
            "description":"Value that uniquely identifies the supplier who ships the item. It's a primary key that the application creates when it creates the supplier.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipFromSupplierSiteName":{
            "type":"string",
            "description":"Name of the supplier site that ships the item.",
            "nullable":true,
            "x-queryable":true
        },
        "SecurityContextCode":{
            "type":"string",
            "description":"Value that identifies the level of security applied. A list of accepted values is defined in the lookup type ORA_VCS_SECURITY_CONTEXT.",
            "nullable":true,
            "x-queryable":true
        },
        "SecurityContext":{
            "type":"string",
            "description":"Value that identifies the level of security applied. Values include supplier or supplier site.",
            "nullable":true,
            "x-queryable":true
        },
        "ShipFromSupplierName":{
            "type":"string",
            "description":"Name of the supplier that ships the item.",
            "nullable":true,
            "x-queryable":true
        },
        "ProcurementBUName":{
            "type":"string",
            "description":"Name of the business unit. The application assigns the supplier site to this business unit.",
            "nullable":true,
            "x-queryable":true
        },
        "OrganizationCode":{
            "type":"string",
            "description":"Abbreviation that identifies the organization that receives the item.",
            "nullable":true,
            "x-queryable":false
        },
        "links":{
            "title":"Links",
            "type":"array",
            "description":"The link relations associated with the resource instance.",
            "items":{
                "$ref":"#/components/schemas/link"
            }
        },
        "SourceSystemCode":{
            "type":"string",
            "description":"Abbreviation that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include ORA_VCS_SRCSYSTEM_EXTERNAL or ORA_VCS_SRCSYSTEM_ORACLE.",
            "nullable":true,
            "x-queryable":false
        },
        "SourceSystem":{
            "type":"string",
            "description":"Value that indicates the product data model source system for the supply plan that's available for supply chain collaboration. Values include External or Oracle.",
            "nullable":true,
            "x-queryable":false
        },
        "DataAccessId":{
            "type":"integer",
            "description":"Value that uniquely identifies the data access security of the collaboration planner.",
            "format":"int64",
            "nullable":false,
            "readOnly":true,
            "x-hints":{
                "precision":18
            },
            "x-queryable":true
        },
        "LastUpdateDate":{
            "type":"string",
            "description":"Date and time when the user most recently updated the data access security.",
            "format":"date-time",
            "nullable":false,
            "readOnly":true,
            "x-queryable":true
        }
    }
}

Nested Schema : Links

Type: array

Title: Links

The link relations associated with the resource instance.

Show Source

• Array of: object link

{
    "title":"Links",
    "type":"array",
    "description":"The link relations associated with the resource instance.",
    "items":{
        "$ref":"#/components/schemas/link"
    }
}

Nested Schema : link

Type: object

Show Source

• href: string
  Title: hyperlink reference

  The URI to the related resource.
• kind: string
  Title: kind

  Allowed Values: [ "collection", "item", "describe", "other" ]

  The kind of the related resource.
• name: string
  Title: name

  The name of the link to the related resource.
• properties: object properties
• rel: string
  Title: relation

  Allowed Values: [ "self", "lov", "parent", "canonical", "child", "enclosure", "action", "custom" ]

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

{
    "type":"object",
    "properties":{
        "kind":{
            "title":"kind",
            "type":"string",
            "description":"The kind of the related resource.",
            "enum":[
                "collection",
                "item",
                "describe",
                "other"
            ]
        },
        "rel":{
            "title":"relation",
            "type":"string",
            "description":"The name of the relation to the resource instance.  Example: self.",
            "enum":[
                "self",
                "lov",
                "parent",
                "canonical",
                "child",
                "enclosure",
                "action",
                "custom"
            ]
        },
        "name":{
            "title":"name",
            "type":"string",
            "description":"The name of the link to the related resource."
        },
        "href":{
            "title":"hyperlink reference",
            "type":"string",
            "description":"The URI to the related resource."
        },
        "properties":{
            "type":"object",
            "properties":{
                "changeIndicator":{
                    "type":"string",
                    "description":"Change indicator or the ETag value of the resource instance."
                }
            }
        }
    }
}

Nested Schema : properties

Type: object

Show Source

• changeIndicator: string
  Change indicator or the ETag value of the resource instance.

{
    "type":"object",
    "properties":{
        "changeIndicator":{
            "type":"string",
            "description":"Change indicator or the ETag value of the resource instance."
        }
    }
}

Back to Top

Examples

This example describes how to update a data access security.

Example cURL Command

Use the following cURL command to submit a request on the REST resource.

curl -X PATCH -u "username:password" -H "Content-Type: application/vnd.oracle.adf.resourceitem+json" -d 'request payload'  "https://servername/fscmRestApi/resources/version/collaborationPlanners/PersonId/child/dataAccessSecurity/DataAccessId"

Example Request Body

The following example includes the contents of the request body in JSON format. You replace the request payload in the cURL command with the contents of the Example Request Body. The request payload specifies attribute values that the command will use in the record that it updates.

{
 "SecurityContext": "Supplier",
 "ShipFromSupplierName": "CV_SuppA05"
}

Example Response Body

The following example includes the contents of the response body in JSON format:

{
    "DataAccessId": 300100120934698,
    "SecurityContextCode": "ORA_VCS_SUPPLIER",
    "SecurityContext": "Supplier",
    "ShipFromSupplierId": 1717,
    "ShipFromSupplierName": "CV_SuppA05",
...
}

Back to Top