Skip to content

Latest commit

 

History

History
453 lines (330 loc) · 25.4 KB

ItemNotesApi.md

File metadata and controls

453 lines (330 loc) · 25.4 KB

BeLenka\SAP\PurchaseOrder\ItemNotesApi

All URIs are relative to https://:/sap/opu/odata4/sap/api_purchaseorder_2/srvd_a2x/sap/purchaseorder/0001, except if the operation defines another base path.

Method HTTP request Description
purchaseOrderItemNoteGet() GET /PurchaseOrderItemNote Get entities from PurchaseOrderItemNote
purchaseOrderItemNotePurchaseOrderPurchaseOrderItemTextObjectTypeLanguageGet() GET /PurchaseOrderItemNote/{PurchaseOrder}/{PurchaseOrderItem}/{TextObjectType}/{Language} Get entity from PurchaseOrderItemNote by key
purchaseOrderItemNotePurchaseOrderPurchaseOrderItemTextObjectTypeLanguagePurchaseOrderGet() GET /PurchaseOrderItemNote/{PurchaseOrder}/{PurchaseOrderItem}/{TextObjectType}/{Language}/_PurchaseOrder Get related _PurchaseOrder
purchaseOrderItemNotePurchaseOrderPurchaseOrderItemTextObjectTypeLanguagePurchaseOrderItemGet() GET /PurchaseOrderItemNote/{PurchaseOrder}/{PurchaseOrderItem}/{TextObjectType}/{Language}/_PurchaseOrderItem Get related _PurchaseOrderItem
purchaseOrderItemPurchaseOrderPurchaseOrderItemPurchaseOrderItemNoteGet() GET /PurchaseOrderItem/{PurchaseOrder}/{PurchaseOrderItem}/_PurchaseOrderItemNote Get entities from related _PurchaseOrderItemNote
purchaseOrderItemPurchaseOrderPurchaseOrderItemPurchaseOrderItemNotePost() POST /PurchaseOrderItem/{PurchaseOrder}/{PurchaseOrderItem}/_PurchaseOrderItemNote Add new entity to related _PurchaseOrderItemNote

purchaseOrderItemNoteGet()

purchaseOrderItemNoteGet($top, $skip, $filter, $count, $orderby, $select, $expand): \BeLenka\SAP\PurchaseOrder\Model\CollectionOfPurchaseOrderItemNoteType

Get entities from PurchaseOrderItemNote

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\PurchaseOrder\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\PurchaseOrder\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\PurchaseOrder\Api\ItemNotesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$top = 50; // int | Show only the first n items, see [Paging - Top](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptiontop)
$skip = 56; // int | Skip the first n items, see [Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip)
$filter = 'filter_example'; // string | Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)
$count = True; // bool | Include count of items, see [Count](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount)
$orderby = array('orderby_example'); // string[] | Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)

try {
    $result = $apiInstance->purchaseOrderItemNoteGet($top, $skip, $filter, $count, $orderby, $select, $expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemNotesApi->purchaseOrderItemNoteGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
top int Show only the first n items, see Paging - Top [optional]
skip int Skip the first n items, see Paging - Skip [optional]
filter string Filter items by property values, see Filtering [optional]
count bool Include count of items, see Count [optional]
orderby string[] Order items by property values, see Sorting [optional]
select string[] Select properties to be returned, see Select [optional]
expand string[] Expand related entities, see Expand [optional]

Return type

\BeLenka\SAP\PurchaseOrder\Model\CollectionOfPurchaseOrderItemNoteType

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

purchaseOrderItemNotePurchaseOrderPurchaseOrderItemTextObjectTypeLanguageGet()

purchaseOrderItemNotePurchaseOrderPurchaseOrderItemTextObjectTypeLanguageGet($purchase_order, $purchase_order_item, $text_object_type, $language, $select, $expand): \BeLenka\SAP\PurchaseOrder\Model\ComSapGatewaySrvdA2xApiPurchaseorder2V0001PurchaseOrderItemNoteType

Get entity from PurchaseOrderItemNote by key

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\PurchaseOrder\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\PurchaseOrder\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\PurchaseOrder\Api\ItemNotesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$purchase_order = 'purchase_order_example'; // string | Purchase Order Number
$purchase_order_item = 'purchase_order_item_example'; // string | Item Number of Purchase Order
$text_object_type = 'text_object_type_example'; // string | Text ID
$language = 'language_example'; // string | Language Key
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)

try {
    $result = $apiInstance->purchaseOrderItemNotePurchaseOrderPurchaseOrderItemTextObjectTypeLanguageGet($purchase_order, $purchase_order_item, $text_object_type, $language, $select, $expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemNotesApi->purchaseOrderItemNotePurchaseOrderPurchaseOrderItemTextObjectTypeLanguageGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
purchase_order string Purchase Order Number
purchase_order_item string Item Number of Purchase Order
text_object_type string Text ID
language string Language Key
select string[] Select properties to be returned, see Select [optional]
expand string[] Expand related entities, see Expand [optional]

Return type

\BeLenka\SAP\PurchaseOrder\Model\ComSapGatewaySrvdA2xApiPurchaseorder2V0001PurchaseOrderItemNoteType

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

purchaseOrderItemNotePurchaseOrderPurchaseOrderItemTextObjectTypeLanguagePurchaseOrderGet()

purchaseOrderItemNotePurchaseOrderPurchaseOrderItemTextObjectTypeLanguagePurchaseOrderGet($purchase_order, $purchase_order_item, $text_object_type, $language, $select, $expand): \BeLenka\SAP\PurchaseOrder\Model\ComSapGatewaySrvdA2xApiPurchaseorder2V0001PurchaseOrderType

Get related _PurchaseOrder

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\PurchaseOrder\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\PurchaseOrder\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\PurchaseOrder\Api\ItemNotesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$purchase_order = 'purchase_order_example'; // string | Purchase Order Number
$purchase_order_item = 'purchase_order_item_example'; // string | Item Number of Purchase Order
$text_object_type = 'text_object_type_example'; // string | Text ID
$language = 'language_example'; // string | Language Key
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)

try {
    $result = $apiInstance->purchaseOrderItemNotePurchaseOrderPurchaseOrderItemTextObjectTypeLanguagePurchaseOrderGet($purchase_order, $purchase_order_item, $text_object_type, $language, $select, $expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemNotesApi->purchaseOrderItemNotePurchaseOrderPurchaseOrderItemTextObjectTypeLanguagePurchaseOrderGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
purchase_order string Purchase Order Number
purchase_order_item string Item Number of Purchase Order
text_object_type string Text ID
language string Language Key
select string[] Select properties to be returned, see Select [optional]
expand string[] Expand related entities, see Expand [optional]

Return type

\BeLenka\SAP\PurchaseOrder\Model\ComSapGatewaySrvdA2xApiPurchaseorder2V0001PurchaseOrderType

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

purchaseOrderItemNotePurchaseOrderPurchaseOrderItemTextObjectTypeLanguagePurchaseOrderItemGet()

purchaseOrderItemNotePurchaseOrderPurchaseOrderItemTextObjectTypeLanguagePurchaseOrderItemGet($purchase_order, $purchase_order_item, $text_object_type, $language, $select, $expand): \BeLenka\SAP\PurchaseOrder\Model\ComSapGatewaySrvdA2xApiPurchaseorder2V0001PurchaseOrderItemType

Get related _PurchaseOrderItem

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\PurchaseOrder\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\PurchaseOrder\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\PurchaseOrder\Api\ItemNotesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$purchase_order = 'purchase_order_example'; // string | Purchase Order Number
$purchase_order_item = 'purchase_order_item_example'; // string | Item Number of Purchase Order
$text_object_type = 'text_object_type_example'; // string | Text ID
$language = 'language_example'; // string | Language Key
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)

try {
    $result = $apiInstance->purchaseOrderItemNotePurchaseOrderPurchaseOrderItemTextObjectTypeLanguagePurchaseOrderItemGet($purchase_order, $purchase_order_item, $text_object_type, $language, $select, $expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemNotesApi->purchaseOrderItemNotePurchaseOrderPurchaseOrderItemTextObjectTypeLanguagePurchaseOrderItemGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
purchase_order string Purchase Order Number
purchase_order_item string Item Number of Purchase Order
text_object_type string Text ID
language string Language Key
select string[] Select properties to be returned, see Select [optional]
expand string[] Expand related entities, see Expand [optional]

Return type

\BeLenka\SAP\PurchaseOrder\Model\ComSapGatewaySrvdA2xApiPurchaseorder2V0001PurchaseOrderItemType

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

purchaseOrderItemPurchaseOrderPurchaseOrderItemPurchaseOrderItemNoteGet()

purchaseOrderItemPurchaseOrderPurchaseOrderItemPurchaseOrderItemNoteGet($purchase_order, $purchase_order_item, $top, $skip, $filter, $count, $orderby, $select, $expand): \BeLenka\SAP\PurchaseOrder\Model\CollectionOfPurchaseOrderItemNoteType

Get entities from related _PurchaseOrderItemNote

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\PurchaseOrder\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\PurchaseOrder\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\PurchaseOrder\Api\ItemNotesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$purchase_order = 'purchase_order_example'; // string | Purchase Order Number
$purchase_order_item = 'purchase_order_item_example'; // string | Item Number of Purchase Order
$top = 50; // int | Show only the first n items, see [Paging - Top](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptiontop)
$skip = 56; // int | Skip the first n items, see [Paging - Skip](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionskip)
$filter = 'filter_example'; // string | Filter items by property values, see [Filtering](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionfilter)
$count = True; // bool | Include count of items, see [Count](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptioncount)
$orderby = array('orderby_example'); // string[] | Order items by property values, see [Sorting](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionorderby)
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionselect)
$expand = array('expand_example'); // string[] | Expand related entities, see [Expand](http://docs.oasis-open.org/odata/odata/v4.01/odata-v4.01-part1-protocol.html#sec_SystemQueryOptionexpand)

try {
    $result = $apiInstance->purchaseOrderItemPurchaseOrderPurchaseOrderItemPurchaseOrderItemNoteGet($purchase_order, $purchase_order_item, $top, $skip, $filter, $count, $orderby, $select, $expand);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemNotesApi->purchaseOrderItemPurchaseOrderPurchaseOrderItemPurchaseOrderItemNoteGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
purchase_order string Purchase Order Number
purchase_order_item string Item Number of Purchase Order
top int Show only the first n items, see Paging - Top [optional]
skip int Skip the first n items, see Paging - Skip [optional]
filter string Filter items by property values, see Filtering [optional]
count bool Include count of items, see Count [optional]
orderby string[] Order items by property values, see Sorting [optional]
select string[] Select properties to be returned, see Select [optional]
expand string[] Expand related entities, see Expand [optional]

Return type

\BeLenka\SAP\PurchaseOrder\Model\CollectionOfPurchaseOrderItemNoteType

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: Not defined
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]

purchaseOrderItemPurchaseOrderPurchaseOrderItemPurchaseOrderItemNotePost()

purchaseOrderItemPurchaseOrderPurchaseOrderItemPurchaseOrderItemNotePost($purchase_order, $purchase_order_item, $com_sap_gateway_srvd_a2x_api_purchaseorder2_v0001_purchase_order_item_note_type_create): \BeLenka\SAP\PurchaseOrder\Model\ComSapGatewaySrvdA2xApiPurchaseorder2V0001PurchaseOrderItemNoteType

Add new entity to related _PurchaseOrderItemNote

Example

<?php
require_once(__DIR__ . '/vendor/autoload.php');


// Configure HTTP basic authorization: BasicAuth
$config = BeLenka\SAP\PurchaseOrder\Configuration::getDefaultConfiguration()
              ->setUsername('YOUR_USERNAME')
              ->setPassword('YOUR_PASSWORD');

// Configure OAuth2 access token for authorization: OAuth2Auth
$config = BeLenka\SAP\PurchaseOrder\Configuration::getDefaultConfiguration()->setAccessToken('YOUR_ACCESS_TOKEN');


$apiInstance = new BeLenka\SAP\PurchaseOrder\Api\ItemNotesApi(
    // If you want use custom http client, pass your client which implements `GuzzleHttp\ClientInterface`.
    // This is optional, `GuzzleHttp\Client` will be used as default.
    new GuzzleHttp\Client(),
    $config
);
$purchase_order = 'purchase_order_example'; // string | Purchase Order Number
$purchase_order_item = 'purchase_order_item_example'; // string | Item Number of Purchase Order
$com_sap_gateway_srvd_a2x_api_purchaseorder2_v0001_purchase_order_item_note_type_create = new \BeLenka\SAP\PurchaseOrder\Model\ComSapGatewaySrvdA2xApiPurchaseorder2V0001PurchaseOrderItemNoteTypeCreate(); // \BeLenka\SAP\PurchaseOrder\Model\ComSapGatewaySrvdA2xApiPurchaseorder2V0001PurchaseOrderItemNoteTypeCreate | New entity

try {
    $result = $apiInstance->purchaseOrderItemPurchaseOrderPurchaseOrderItemPurchaseOrderItemNotePost($purchase_order, $purchase_order_item, $com_sap_gateway_srvd_a2x_api_purchaseorder2_v0001_purchase_order_item_note_type_create);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling ItemNotesApi->purchaseOrderItemPurchaseOrderPurchaseOrderItemPurchaseOrderItemNotePost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
purchase_order string Purchase Order Number
purchase_order_item string Item Number of Purchase Order
com_sap_gateway_srvd_a2x_api_purchaseorder2_v0001_purchase_order_item_note_type_create \BeLenka\SAP\PurchaseOrder\Model\ComSapGatewaySrvdA2xApiPurchaseorder2V0001PurchaseOrderItemNoteTypeCreate New entity

Return type

\BeLenka\SAP\PurchaseOrder\Model\ComSapGatewaySrvdA2xApiPurchaseorder2V0001PurchaseOrderItemNoteType

Authorization

BasicAuth, OAuth2Auth

HTTP request headers

  • Content-Type: application/json
  • Accept: application/json

[Back to top] [Back to API list] [Back to Model list] [Back to README]