Skip to content

Latest commit

 

History

History
507 lines (357 loc) · 22.4 KB

SupplierTextApi.md

File metadata and controls

507 lines (357 loc) · 22.4 KB

BeLenka\SAP\BusinessPartner\SupplierTextApi

All URIs are relative to https://:/sap/opu/odata/sap/API_BUSINESS_PARTNER, except if the operation defines another base path.

Method HTTP request Description
aSupplierSupplierToSupplierTextGet() GET /A_Supplier('{Supplier}')/to_SupplierText Retrieves supplier text data.
aSupplierSupplierToSupplierTextPost() POST /A_Supplier('{Supplier}')/to_SupplierText Creates supplier text data.
aSupplierTextGet() GET /A_SupplierText Retrieves supplier text data.
aSupplierTextPost() POST /A_SupplierText Creates supplier text data.
aSupplierTextSupplierSupplierLanguageLanguageLongTextIDLongTextIDDelete() DELETE /A_SupplierText(Supplier='{Supplier}',Language='{Language}',LongTextID='{LongTextID}') Deletes supplier text data by key fields.
aSupplierTextSupplierSupplierLanguageLanguageLongTextIDLongTextIDGet() GET /A_SupplierText(Supplier='{Supplier}',Language='{Language}',LongTextID='{LongTextID}') Retrieves supplier text data by key fields.
aSupplierTextSupplierSupplierLanguageLanguageLongTextIDLongTextIDPatch() PATCH /A_SupplierText(Supplier='{Supplier}',Language='{Language}',LongTextID='{LongTextID}') Updates supplier text data by key fields.

aSupplierSupplierToSupplierTextGet()

aSupplierSupplierToSupplierTextGet($supplier, $top, $skip, $filter, $inlinecount, $orderby, $select): \BeLenka\SAP\BusinessPartner\Model\Wrapper54

Retrieves supplier text data.

Retrieves all the supplier text data attached to purchasing organization in the system.

Example

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


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

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


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\SupplierTextApi(
    // 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
);
$supplier = 'supplier_example'; // string | Account Number of Supplier
$top = 50; // int | Show only the first n items, see [Paging - Top](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)
$skip = 56; // int | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)
$filter = 'filter_example'; // string | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)
$inlinecount = 'inlinecount_example'; // string | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)
$orderby = array('orderby_example'); // string[] | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)

try {
    $result = $apiInstance->aSupplierSupplierToSupplierTextGet($supplier, $top, $skip, $filter, $inlinecount, $orderby, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SupplierTextApi->aSupplierSupplierToSupplierTextGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
supplier string Account Number of Supplier
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]
inlinecount string Include count of items, see Inlinecount [optional]
orderby string[] Order items by property values, see Sorting [optional]
select string[] Select properties to be returned, see Select [optional]

Return type

\BeLenka\SAP\BusinessPartner\Model\Wrapper54

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]

aSupplierSupplierToSupplierTextPost()

aSupplierSupplierToSupplierTextPost($supplier, $apibusinesspartnera_supplier_text_type_create): \BeLenka\SAP\BusinessPartner\Model\ASupplierTextType

Creates supplier text data.

Creates text data attached to a supplier in the system.

Example

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


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

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


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\SupplierTextApi(
    // 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
);
$supplier = 'supplier_example'; // string | Account Number of Supplier
$apibusinesspartnera_supplier_text_type_create = new \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERASupplierTextTypeCreate(); // \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERASupplierTextTypeCreate | New entity

try {
    $result = $apiInstance->aSupplierSupplierToSupplierTextPost($supplier, $apibusinesspartnera_supplier_text_type_create);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SupplierTextApi->aSupplierSupplierToSupplierTextPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
supplier string Account Number of Supplier
apibusinesspartnera_supplier_text_type_create \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERASupplierTextTypeCreate New entity

Return type

\BeLenka\SAP\BusinessPartner\Model\ASupplierTextType

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]

aSupplierTextGet()

aSupplierTextGet($top, $skip, $filter, $inlinecount, $orderby, $select): \BeLenka\SAP\BusinessPartner\Model\Wrapper54

Retrieves supplier text data.

Retrieves all the supplier text data attached to purchasing organization in the system.

Example

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


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

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


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\SupplierTextApi(
    // 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](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=66)
$skip = 56; // int | Skip the first n items, see [Paging - Skip](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)
$filter = 'filter_example'; // string | Filter items by property values, see [Filtering](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=64)
$inlinecount = 'inlinecount_example'; // string | Include count of items, see [Inlinecount](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=67)
$orderby = array('orderby_example'); // string[] | Order items by property values, see [Sorting](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=65)
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)

try {
    $result = $apiInstance->aSupplierTextGet($top, $skip, $filter, $inlinecount, $orderby, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SupplierTextApi->aSupplierTextGet: ', $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]
inlinecount string Include count of items, see Inlinecount [optional]
orderby string[] Order items by property values, see Sorting [optional]
select string[] Select properties to be returned, see Select [optional]

Return type

\BeLenka\SAP\BusinessPartner\Model\Wrapper54

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]

aSupplierTextPost()

aSupplierTextPost($apibusinesspartnera_supplier_text_type_create): \BeLenka\SAP\BusinessPartner\Model\ASupplierTextType

Creates supplier text data.

Creates text data attached to a supplier in the system.

Example

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


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

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


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\SupplierTextApi(
    // 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
);
$apibusinesspartnera_supplier_text_type_create = new \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERASupplierTextTypeCreate(); // \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERASupplierTextTypeCreate | New entity

try {
    $result = $apiInstance->aSupplierTextPost($apibusinesspartnera_supplier_text_type_create);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SupplierTextApi->aSupplierTextPost: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
apibusinesspartnera_supplier_text_type_create \BeLenka\SAP\BusinessPartner\Model\APIBUSINESSPARTNERASupplierTextTypeCreate New entity

Return type

\BeLenka\SAP\BusinessPartner\Model\ASupplierTextType

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]

aSupplierTextSupplierSupplierLanguageLanguageLongTextIDLongTextIDDelete()

aSupplierTextSupplierSupplierLanguageLanguageLongTextIDLongTextIDDelete($supplier, $language, $long_text_id)

Deletes supplier text data by key fields.

Deletes text data linked to supplier by Supplier, Language, and LongTextID fields.

Example

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


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

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


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\SupplierTextApi(
    // 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
);
$supplier = 'supplier_example'; // string | Account Number of Supplier
$language = 'language_example'; // string | Language key
$long_text_id = 'long_text_id_example'; // string | Text ID

try {
    $apiInstance->aSupplierTextSupplierSupplierLanguageLanguageLongTextIDLongTextIDDelete($supplier, $language, $long_text_id);
} catch (Exception $e) {
    echo 'Exception when calling SupplierTextApi->aSupplierTextSupplierSupplierLanguageLanguageLongTextIDLongTextIDDelete: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
supplier string Account Number of Supplier
language string Language key
long_text_id string Text ID

Return type

void (empty response body)

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]

aSupplierTextSupplierSupplierLanguageLanguageLongTextIDLongTextIDGet()

aSupplierTextSupplierSupplierLanguageLanguageLongTextIDLongTextIDGet($supplier, $language, $long_text_id, $select): \BeLenka\SAP\BusinessPartner\Model\ASupplierTextType

Retrieves supplier text data by key fields.

Retrieves supplier purchasing organization text data by using Supplier, Language, and LongTextID fields.

Example

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


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

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


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\SupplierTextApi(
    // 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
);
$supplier = 'supplier_example'; // string | Account Number of Supplier
$language = 'language_example'; // string | Language key
$long_text_id = 'long_text_id_example'; // string | Text ID
$select = array('select_example'); // string[] | Select properties to be returned, see [Select](https://help.sap.com/doc/5890d27be418427993fafa6722cdc03b/Cloud/en-US/OdataV2.pdf#page=68)

try {
    $result = $apiInstance->aSupplierTextSupplierSupplierLanguageLanguageLongTextIDLongTextIDGet($supplier, $language, $long_text_id, $select);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling SupplierTextApi->aSupplierTextSupplierSupplierLanguageLanguageLongTextIDLongTextIDGet: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
supplier string Account Number of Supplier
language string Language key
long_text_id string Text ID
select string[] Select properties to be returned, see Select [optional]

Return type

\BeLenka\SAP\BusinessPartner\Model\ASupplierTextType

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]

aSupplierTextSupplierSupplierLanguageLanguageLongTextIDLongTextIDPatch()

aSupplierTextSupplierSupplierLanguageLanguageLongTextIDLongTextIDPatch($supplier, $language, $long_text_id, $modified_a_supplier_text_type)

Updates supplier text data by key fields.

Updates text data linked to supplier by using Supplier, Language and LongTextID fields.

Example

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


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

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


$apiInstance = new BeLenka\SAP\BusinessPartner\Api\SupplierTextApi(
    // 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
);
$supplier = 'supplier_example'; // string | Account Number of Supplier
$language = 'language_example'; // string | Language key
$long_text_id = 'long_text_id_example'; // string | Text ID
$modified_a_supplier_text_type = new \BeLenka\SAP\BusinessPartner\Model\ModifiedASupplierTextType(); // \BeLenka\SAP\BusinessPartner\Model\ModifiedASupplierTextType | New property values

try {
    $apiInstance->aSupplierTextSupplierSupplierLanguageLanguageLongTextIDLongTextIDPatch($supplier, $language, $long_text_id, $modified_a_supplier_text_type);
} catch (Exception $e) {
    echo 'Exception when calling SupplierTextApi->aSupplierTextSupplierSupplierLanguageLanguageLongTextIDLongTextIDPatch: ', $e->getMessage(), PHP_EOL;
}

Parameters

Name Type Description Notes
supplier string Account Number of Supplier
language string Language key
long_text_id string Text ID
modified_a_supplier_text_type \BeLenka\SAP\BusinessPartner\Model\ModifiedASupplierTextType New property values

Return type

void (empty response body)

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]